Skip to content

Commit

Permalink
Readme note about normalizing quotes
Browse files Browse the repository at this point in the history
  • Loading branch information
dpilafian committed Oct 12, 2023
1 parent 32b56f9 commit 0b09fb8
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 7 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,15 +67,20 @@ The default value for `--ext` is: `".html,.htm,.php,.aspx,.asp,.jsp"`
### 4. Example CLI usage
Examples:
- `img-src-placeholder src/web build/website`<br>
Recursively copy all HTML files in the **src/web** folder to the **build/website** folder and
replace the "hash" placeholder image sources with an inline data URL for a transparent 1 pixel
Recursively copies all HTML files in the **src/web** folder to the **build/website** folder and
replaces the "hash" placeholder image sources with an inline data URL for a transparent 1 pixel
image.

- `img-src-placeholder src/web build/website --summary`<br>
Display the summary but not the individual files copied.
Displays the summary but not the individual files copied.

- `img-src-placeholder src/web build/website --ext=.php`<br>
Only process PHP files.
Only processes PHP files.

- `img-src-placeholder src/web 'build/Website Root' --ext=.php`<br>
Specifies a destination folder that has a space in its name.

_**Note:** Single quotes in commands are normalized so they work cross-platform and avoid the errors often encountered on Microsoft Windows._

## C) Application Code
Even though **img-src-placeholder** is primarily intended for build scripts, the package can be used programmatically in ESM and TypeScript projects.
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -93,13 +93,13 @@
},
"devDependencies": {
"@types/fancy-log": "~2.0",
"@types/node": "~20.6",
"@types/node": "~20.8",
"@typescript-eslint/eslint-plugin": "~6.7",
"@typescript-eslint/parser": "~6.7",
"add-dist-header": "~1.3",
"assert-deep-strict-equal": "~1.1",
"copy-file-util": "~1.1",
"eslint": "~8.50",
"eslint": "~8.51",
"jshint": "~2.13",
"mocha": "~10.2",
"rimraf": "~5.0",
Expand Down
2 changes: 1 addition & 1 deletion task-runner.sh.command
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ releaseInstructions() {
echo "When ready to do the next release:"
echo
echo " === Increment version ==="
echo " Edit pacakge.json to bump $version to next version number"
echo " Edit package.json to bump $version to next version number"
echo " $projectHome/package.json"
}
nextActionCommitTagPub() {
Expand Down

0 comments on commit 0b09fb8

Please sign in to comment.