From 0b09fb8d0a75beeab95d969122ae79fcc36e3bde Mon Sep 17 00:00:00 2001 From: dpilafian Date: Thu, 12 Oct 2023 00:40:43 -0700 Subject: [PATCH] Readme note about normalizing quotes --- README.md | 13 +++++++++---- package.json | 4 ++-- task-runner.sh.command | 2 +- 3 files changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 202904e..559343b 100644 --- a/README.md +++ b/README.md @@ -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`
- 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`
- 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`
- Only process PHP files. + Only processes PHP files. + + - `img-src-placeholder src/web 'build/Website Root' --ext=.php`
+ 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. diff --git a/package.json b/package.json index 78a40c5..ba8a008 100644 --- a/package.json +++ b/package.json @@ -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", diff --git a/task-runner.sh.command b/task-runner.sh.command index 22bebf8..2431272 100755 --- a/task-runner.sh.command +++ b/task-runner.sh.command @@ -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() {