@@ -94,9 +94,9 @@ The CLI is divided into a main command and multiple sub-commands.
9494The main command is useful for getting usage help. Run the command without any
9595flags to get information about the different options. Useful flags include:
9696
97- - ` -h --help ` : display help for command
98- - ` -v --version ` : output the version number
99- - ` -c, --config ` : display the tool's detected configuration
97+ - ` -h --help ` : display help for command
98+ - ` -v --version ` : output the version number
99+ - ` -c, --config ` : display the tool's detected configuration
100100
101101Utilities happen through sub-commands:
102102
@@ -108,25 +108,25 @@ create a new folder with the project name that will hold your project. On the
108108other hand, ` init ` will initialize the project in the current directory, thus,
109109expecting the same to be empty.
110110
111- - ` create [options] <project-name> ` : create a new project with the given
112- project name.
113- - ` init [options] ` : initialize a project in the current folder.
111+ - ` create [options] <project-name> ` : create a new project with the given
112+ project name.
113+ - ` init [options] ` : initialize a project in the current folder.
114114
115115A ` <project-name> ` is any valid project identifier, that is, any string that i
116116valid folder name and contains no spaces.
117117
118118Valid options include:
119119
120- - ` -t, --type <project-type> ` : the project type to create, one of ` Library ` ,
121- ` CLILibrary ` , ` ReactLibrary ` , ` NonCode ` (default: "Library")
122- - ` -p, --package-manager <package-manager> ` : the project manager to use, one
123- of ` npm ` , ` yarn ` , ` pnpm ` (default: "npm")
124- - ` -s --silent ` : run silently, not displaying the tool's banner (default:
125- false)
126- - ` -D, --debug ` : run in debug mode, printing all the internal tool's
127- processing (default: false)
128- - ` -T, --test ` : run using verdaccio as a registry (default: false)
129- - ` -h, --help ` : display help for command
120+ - ` -t, --type <project-type> ` : the project type to create, one of ` Library ` ,
121+ ` CLILibrary ` , ` ReactLibrary ` , ` NonCode ` (default: "Library")
122+ - ` -p, --package-manager <package-manager> ` : the project manager to use, one
123+ of ` npm ` , ` yarn ` , ` pnpm ` (default: "npm")
124+ - ` -s --silent ` : run silently, not displaying the tool's banner (default:
125+ false)
126+ - ` -D, --debug ` : run in debug mode, printing all the internal tool's
127+ processing (default: false)
128+ - ` -T, --test ` : run using verdaccio as a registry (default: false)
129+ - ` -h, --help ` : display help for command
130130
131131A special mention is to be held for the ` -T ` flag, which is not
132132self-explanatory. See the ** Manually testing newer versions of the library**
@@ -148,21 +148,21 @@ The `update` sub-command is intended to update the project's configuration files
148148that live at the root of the project. This command is intended to be executed
149149inside an already created project.
150150
151- - ` update [options] ` : update the root files of the project.
151+ - ` update [options] ` : update the root files of the project.
152152
153153The command has the following options.
154154
155- - ` -i, --items <item> ` : the items to update. One of ` all ` , ` husky ` , ` github ` ,
156- ` vscode ` , ` license ` , ` contributing ` , ` editorconfig ` , ` prettier ` , ` npm ` ,
157- ` eslint ` , ` git ` , ` commitlint ` (default: ` all ` )
158- - ` -t, --type <project-type> ` : the project type to create, one of ` Library ` ,
159- ` CLILibrary ` , ` ReactLibrary ` , ` NonCode ` (default: "Library")
160- - ` -s --silent ` : run silently, not displaying the tool's banner (default:
161- false)
162- - ` -D, --debug ` : run in debug mode, printing all the internal tool's
163- processing (default: false)
164- - ` -T, --test ` : run using verdaccio as a registry (default: false)
165- - ` -h, --help ` : display help for command
155+ - ` -i, --items <item> ` : the items to update. One of ` all ` , ` husky ` , ` github ` ,
156+ ` vscode ` , ` license ` , ` contributing ` , ` editorconfig ` , ` prettier ` , ` npm ` ,
157+ ` eslint ` , ` git ` , ` commitlint ` (default: ` all ` )
158+ - ` -t, --type <project-type> ` : the project type to create, one of ` Library ` ,
159+ ` CLILibrary ` , ` ReactLibrary ` , ` NonCode ` (default: "Library")
160+ - ` -s --silent ` : run silently, not displaying the tool's banner (default:
161+ false)
162+ - ` -D, --debug ` : run in debug mode, printing all the internal tool's
163+ processing (default: false)
164+ - ` -T, --test ` : run using verdaccio as a registry (default: false)
165+ - ` -h, --help ` : display help for command
166166
167167By default, all root files are updated, but through the ` -i ` flag a specific
168168file can be updated. ` -i ` flag expects only one file at a time, that is, execute
@@ -200,19 +200,19 @@ your project, and these files will be used instead of the ones in the
200200gobstones-scripts folder. Note that usually you will not need to eject all
201201files, but only the one of a specific tool, use ` -i ` flag for that.
202202
203- - ` eject [options] ` : eject the configuration files of the project.
203+ - ` eject [options] ` : eject the configuration files of the project.
204204
205205This sub-command have the following options:
206206
207- - ` -i, --items <item> ` : The items to update. One of ` all ` , nps` , ` rollup`,
208- ` typescript ` , ` typedoc ` , ` jest ` (default: "all")
209- - ` -t, --type <project-type> ` : the project type to create, one of ` Library ` ,
210- ` CLILibrary ` , ` ReactLibrary ` , ` NonCode ` (default: "Library")
211- - ` -s --silent ` : run silently, not displaying the tool's banner (default:
212- false)
213- - ` -D, --debug ` : run in debug mode, printing all the internal tool's
214- processing (default: false)
215- - ` -h, --help ` : display help for command
207+ - ` -i, --items <item> ` : The items to update. One of ` all ` , nps` , ` rollup`,
208+ ` typescript ` , ` typedoc ` , ` jest ` (default: "all")
209+ - ` -t, --type <project-type> ` : the project type to create, one of ` Library ` ,
210+ ` CLILibrary ` , ` ReactLibrary ` , ` NonCode ` (default: "Library")
211+ - ` -s --silent ` : run silently, not displaying the tool's banner (default:
212+ false)
213+ - ` -D, --debug ` : run in debug mode, printing all the internal tool's
214+ processing (default: false)
215+ - ` -h, --help ` : display help for command
216216
217217An example will be:
218218
@@ -231,43 +231,43 @@ The `run` sub-command is used to execute a particular `nps` command through the
231231abstracted configuration provided by ` gobstones-script ` (except ejected files,
232232in which cae, the ejected configuration will be used).
233233
234- - ` run [options] [command] [...args] ` : run a command with nps.
234+ - ` run [options] [command] [...args] ` : run a command with nps.
235235
236236As you can see, you can call ` run ` with no options. In this case, the default
237237` nps ` command will be executed. Else, you can provide a particular command (one
238238of the nps provided commands) and some arguments.
239239
240240Available options include:
241241
242- - ` -t, --type <project-type> ` : the project type to create, one of ` Library ` ,
243- ` CLILibrary ` , ` ReactLibrary ` , ` NonCode ` (default: "Library")
244- - ` -p, --package-manager <package-manager> ` : the project manager to use, one
245- of ` npm ` , ` yarn ` , ` pnpm ` (default: "npm")
246- - ` -s --silent ` : run silently, not displaying the tool's banner (default:
247- false)
248- - ` -D, --debug ` : run in debug mode, printing all the internal tool's
249- processing (default: false)
250- - ` -h, --help ` : display help for command
242+ - ` -t, --type <project-type> ` : the project type to create, one of ` Library ` ,
243+ ` CLILibrary ` , ` ReactLibrary ` , ` NonCode ` (default: "Library")
244+ - ` -p, --package-manager <package-manager> ` : the project manager to use, one
245+ of ` npm ` , ` yarn ` , ` pnpm ` (default: "npm")
246+ - ` -s --silent ` : run silently, not displaying the tool's banner (default:
247+ false)
248+ - ` -D, --debug ` : run in debug mode, printing all the internal tool's
249+ processing (default: false)
250+ - ` -h, --help ` : display help for command
251251
252252Available commands depend on project type, and can be found by executing the
253253default action, as presenting the help is the default behavior for any project.
254254Some common actions include
255255
256- - ` dev ` : run the project in development mode.
257- - ` build ` : build the project and output it to ` ./dist `
258- - ` test ` : run the project's tests, generating coverage reports at
259- ` ./coverage ` .
260- - ` test -- --serve ` : run the project's tests, generating coverage reports at
261- ` ./coverage ` . and serve the generated folder in a local server.
262- - ` doc ` : build the documentation and output it to ` ./docs `
263- - ` doc -- --serve ` : build the documentation and output it to ` ./docs ` , and
264- serve the folder in a local server.
265- - ` lint ` : lint the files in the project.
266- - ` lint -- --fix ` : lint the files in the project and fix all auto-fixable
267- errors.
268- - ` prettify ` : run prettier with auto-fix in all project files.
269- - ` clear ` : delete all auto-generated files.
270- - ` changelog ` : append the latest tag information to the changelog.
256+ - ` dev ` : run the project in development mode.
257+ - ` build ` : build the project and output it to ` ./dist `
258+ - ` test ` : run the project's tests, generating coverage reports at
259+ ` ./coverage ` .
260+ - ` test -- --serve ` : run the project's tests, generating coverage reports at
261+ ` ./coverage ` . and serve the generated folder in a local server.
262+ - ` doc ` : build the documentation and output it to ` ./docs `
263+ - ` doc -- --serve ` : build the documentation and output it to ` ./docs ` , and
264+ serve the folder in a local server.
265+ - ` lint ` : lint the files in the project.
266+ - ` lint -- --fix ` : lint the files in the project and fix all auto-fixable
267+ errors.
268+ - ` prettify ` : run prettier with auto-fix in all project files.
269+ - ` clear ` : delete all auto-generated files.
270+ - ` changelog ` : append the latest tag information to the changelog.
271271
272272See the ** Running commands using gobstones-scripts** for more information.
273273
@@ -282,16 +282,16 @@ modifications to the `package.json` file.
282282When running a command using _ gobstones-scripts_ the tool loads all
283283configuration for the different tooling from one of two locations.
284284
285- - If a configuration file for a tool is present at the root of your project,
286- that configuration is used. As an example, if you have a ` rollup.config.js `
287- file in the root of your project, then that file is used to load the Rollup
288- configuration.
289- - If a configuration file for a tool is not present at the root of your
290- project, then the default configuration file from gobstones-scripts is used.
291- This configuration files are at
292- ` ./node_modules/@gobstones/gobstones-scripts/config ` , and they should not be
293- modified by the end user. If you need changes over a default configuration,
294- you should eject that configuration file to the root of your project.
285+ - If a configuration file for a tool is present at the root of your project,
286+ that configuration is used. As an example, if you have a ` rollup.config.js `
287+ file in the root of your project, then that file is used to load the Rollup
288+ configuration.
289+ - If a configuration file for a tool is not present at the root of your
290+ project, then the default configuration file from gobstones-scripts is used.
291+ This configuration files are at
292+ ` ./node_modules/@gobstones/gobstones-scripts/config ` , and they should not be
293+ modified by the end user. If you need changes over a default configuration,
294+ you should eject that configuration file to the root of your project.
295295
296296## Running commands using gobstones-scripts
297297
@@ -343,7 +343,6 @@ configuration folder in `node_modules`.
343343If you require the tool's detected configuration file you may import it from the
344344` _helpers.ts ` file at the ` .scripts ` folder.
345345
346-
347346## API
348347
349348You can access the API by importing the module
@@ -394,21 +393,21 @@ the experimental state.
394393
395394The underlying technologies in use include
396395
397- - ** typescript** (tsc for building)
398- - ** rollup** (for bundling libraries and cli-libraries)
399- - ** vite** (for bundling react-libraries)
400- - ** eslint** (for linting)
401- - ** prettier** (for styling)
402- - ** typedoc** (for documentation generation)
403- - ** storybook** (for testing and documenting react-libraries)
404- - ** zx** (for orchestrating the tooling and scripts)
405- - ** husky** (for hooking into git actions)
396+ - ** typescript** (tsc for building)
397+ - ** rollup** (for bundling libraries and cli-libraries)
398+ - ** vite** (for bundling react-libraries)
399+ - ** eslint** (for linting)
400+ - ** prettier** (for styling)
401+ - ** typedoc** (for documentation generation)
402+ - ** storybook** (for testing and documenting react-libraries)
403+ - ** zx** (for orchestrating the tooling and scripts)
404+ - ** husky** (for hooking into git actions)
406405
407406Other files copied to your project will include
408407
409- - ** .editorconfig** (for editor styling, matching prettier)
410- - ** .gitignore** (for git management)
411- - ** .npmignore** (for publishing configuration)
408+ - ** .editorconfig** (for editor styling, matching prettier)
409+ - ** .gitignore** (for git management)
410+ - ** .npmignore** (for publishing configuration)
412411
413412Also a ** .github** folder will configure GitHub actions, and a ** .vscode**
414413folder will configure your Visual Studio Code environment on first run.
@@ -445,8 +444,8 @@ npm start build
445444```
446445
447446The ` test ` performs linting, and then it attempts to create a project of each
448- type available at ` test/.temp ` and run the basic command of ` dev ` , ` build ` ,
449- ` test ` and ` doc ` in each created project. You may run it by calling:
447+ type available at ` test/.temp ` and run the basic command of ` dev ` , ` build ` ,
448+ ` test ` and ` doc ` in each created project. You may run it by calling:
450449
451450``` sh
452451npm start test
0 commit comments