Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat/cli #22

Merged
merged 19 commits into from
Nov 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions cli/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# The VSF Integration Builder's CLI

The VSF Integration Builder's CLI is a local command line interface built to help you move quickly when creating an integration. It provides a fast and efficient way to scaffold new methods and perform various tasks related to your integration project.

## Usage
run `yarn vsf` to see the available commands.

### Add a new endpoint
example: `yarn vsf add endpoint getProducts`


## Making changes to the CLI
Feel free to make as many changes as you like to the CLI. You own it now. If you'd like to make changes to the templates, you can find them in the `templates` folder. If you'd like to add new commands, you can find them in the `commands` folder.

But sure to run `yarn build:cli` from the project root directory after making changes to the cli. This will compile the typescript into javascript and make it available to run.

## Contributions
If you'd like improve this cli for all integrators, please feel free to make a PR the in [integration boilerplate repo](https://github.com/vuestorefront/integration-boilerplate). We're happy to see what you can come up with.
19 changes: 19 additions & 0 deletions cli/build.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import { defineBuildConfig } from 'unbuild'

export default defineBuildConfig({
rollup: {
inlineDependencies: true,
},
entries: ['src/index'],
externals: [
'citty',
'fsevents',
'node:url',
'node:buffer',
'node:path',
'node:child_process',
'node:process',
'node:path',
'node:os',
],
})
3 changes: 3 additions & 0 deletions cli/cli.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export const config = {
integrationName: "boilerplate"
}
Loading
Loading