@@ -18,6 +18,11 @@ Sponsoring means you directly contribute to new features, improvements, and main
1818
1919[ Become a Sponsor →] ( https://github.com/sponsors/rdlabo )
2020
21+ ## Requirements
22+
23+ - Node.js >= 20
24+ - ionicons >= 6.0.0
25+
2126## Initialize
2227
2328``` bash
@@ -88,6 +93,14 @@ It is inefficient to run commands each time before running a production build, s
8893
8994## Optional
9095
96+ ### --dry-run [ boolean]
97+
98+ If you want to see what changes would be made without actually writing them to files, set ` true ` . The default is ` false ` .
99+
100+ ``` bash
101+ npx @rdlabo/ionic-angular-collect-icons --dry-run true
102+ ```
103+
91104### --interactive [ boolean]
92105
93106If you want to set all CLI option using the prompts, set ` true ` . This can be used to check only the results in a Dry run.
@@ -142,7 +155,6 @@ Target files are under the `src` directory from the specified path.
142155
143156- path/to/project + ` src/**/*.ts `
144157- path/to/project + ` src/**/*.html `
145- - path/to/project + ` src/**/*.scss `
146158
147159### --icon-path [ string]
148160
@@ -206,24 +218,25 @@ This is to minimize diffs by libraries. I did not like to have every component c
206218## Developing
207219
2082201 . Clone this repository.
209- 2 . Run ` pnpm install` to install dependencies
210- 3 . Run ` pnpm run dev` to start the dev server, this will watch for changes and rebuild the project
211- 4 . Run ` pnpm run start --filter=cli ` to start the CLI and test the code mods
221+ 2 . Run ` npm install` to install dependencies
222+ 3 . Run ` npm run dev` to start the dev server, this will watch for changes and rebuild the project
223+ 4 . Run ` npm run start` to start the CLI and test the code mods
212224
213225### Testing
214226
215227This project uses [ Vitest] ( https://vitest.dev/ ) for unit testing.
216228
217229| Command | Description |
218230| --------------------- | --------------------------- |
219- | ` pnpm run test ` | Run all tests |
220- | ` pnpm run test:watch ` | Run all tests in watch mode |
231+ | ` npm run test ` | Run all tests |
232+ | ` npm run test:watch ` | Run all tests in watch mode |
233+ | ` npm run coverage ` | Run tests with coverage |
221234
222235### Formatting
223236
224237This project uses [ Prettier] ( https://prettier.io/ ) for code formatting.
225238
226- Run ` pnpm run format ` to format all files in the project.
239+ Run ` npm run fmt ` to format all files in the project.
227240
228241### Additional Resources
229242
0 commit comments