Skip to content

Commit 09fe332

Browse files
committed
Add svgo as npm dependency and setup npm script to run it
1 parent 3558505 commit 09fe332

File tree

3 files changed

+18
-3
lines changed

3 files changed

+18
-3
lines changed

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Don't track the Node.js installation artifacts
2+
/node_modules/
3+
/package-lock.json

README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,19 @@ npm install --save https://github.com/HatScripts/circle-flags
5656
## Contributing
5757

5858
To contribute, you need to have the latest version of [svgo](https://github.com/svg/svgo) installed.
59+
You can run the following command to install it in the circle-flags project directory:
60+
61+
```sh
62+
npm install
63+
```
5964

6065
First, edit the relevant SVG files in the `flags/` directory.
6166

62-
Then run `svgo` to optimize the SVG files:
67+
Then run the `svgo` wrapper script (defined in the scripts section of [package.json](./package.json)),
68+
which uses the locally-installed `svgo` executable to optimize the SVG files:
6369

6470
```sh
65-
svgo ./flags --recursive --config=svgo.config.js
71+
npm run svgo
6672
```
6773

6874
Then commit the changes, and submit them as a pull request.

package.json

+7-1
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,11 @@
3333
"bugs": {
3434
"url": "https://github.com/HatScripts/circle-flags/issues"
3535
},
36-
"homepage": "https://github.com/HatScripts/circle-flags#readme"
36+
"homepage": "https://github.com/HatScripts/circle-flags#readme",
37+
"devDependencies": {
38+
"svgo": "^3.0.2"
39+
},
40+
"scripts": {
41+
"svgo": "node_modules/.bin/svgo ./flags --recursive --config=svgo.config.js"
42+
}
3743
}

0 commit comments

Comments
 (0)