diff --git a/README.md b/README.md index 6c17bd4..6ad9681 100644 --- a/README.md +++ b/README.md @@ -49,17 +49,14 @@ Example **package.json** script: }, ``` -### 2. Global -You can install **add-dist-header** globally and then run it anywhere directly from the terminal. - +### 2. Command-line npx Example terminal commands: ```shell -$ npm install --global add-dist-header -$ add-dist-header "build" "dist" +$ npm install --save-dev add-dist-header +$ npx add-dist-header "build" "dist" [17:13:50] add-dist-header build/my-app.d.ts --> dist/my-app.d.ts (413.11 KB) [17:13:51] add-dist-header build/my-app.js --> dist/my-app.js (1,569.70 KB) ``` - The parameters are optional: ```shell $ add-dist-header #same as above since "build/*" "dist" are the default parameter values @@ -68,6 +65,7 @@ $ add-dist-header #same as above since "build/*" "dist" are the default paramet $ add-dist-header "meta/config.js" #creates "dist/config.js" prepended with header [17:15:03] add-dist-header meta/config.js --> dist/config.js (3.91 KB) ``` +You can also install **add-dist-header** globally (`--global`) and then run it anywhere directly from the terminal. ### 3. CLI flags Command-line flags: @@ -122,6 +120,7 @@ See the **TypeScript Declarations** at the top of [add-dist-header.ts](add-dist- - πŸŽ‹ [add-dist-header](https://github.com/center-key/add-dist-header):  _Prepend a one-line banner comment (with license notice) to distribution files_ - πŸ“„ [copy-file-util](https://github.com/center-key/copy-file-util):  _Copy or rename a file with optional package version number_ - πŸ“‚ [copy-folder-util](https://github.com/center-key/copy-folder-util):  _Recursively copy files from one folder to another folder_ + - πŸͺΊ [recursive-exec](https://github.com/center-key/recursive-exec):  _Run a command on each file in a folder and its subfolders_ - πŸ” [replacer-util](https://github.com/center-key/replacer-util):  _Find and replace strings or template outputs in text files_ - πŸ”’ [rev-web-assets](https://github.com/center-key/rev-web-assets):  _Revision web asset filenames with cache busting content hash fingerprints_ - πŸš† [run-scripts-util](https://github.com/center-key/run-scripts-util):  _Organize npm scripts into named groups of easy to manage commands_ diff --git a/dist/add-dist-header.d.ts b/dist/add-dist-header.d.ts index 194f3b8..347241e 100644 --- a/dist/add-dist-header.d.ts +++ b/dist/add-dist-header.d.ts @@ -1,4 +1,4 @@ -//! add-dist-header v1.2.1 ~~ https://github.com/center-key/add-dist-header ~~ MIT License +//! add-dist-header v1.2.2 ~~ https://github.com/center-key/add-dist-header ~~ MIT License export type Settings = { dist: string; diff --git a/dist/add-dist-header.js b/dist/add-dist-header.js index 3fcfae1..08d7460 100644 --- a/dist/add-dist-header.js +++ b/dist/add-dist-header.js @@ -1,4 +1,4 @@ -//! add-dist-header v1.2.1 ~~ https://github.com/center-key/add-dist-header ~~ MIT License +//! add-dist-header v1.2.2 ~~ https://github.com/center-key/add-dist-header ~~ MIT License import { isBinary } from 'istextorbinary'; import path from 'path'; diff --git a/package.json b/package.json index 9f299a7..eeeb4fb 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "add-dist-header", - "version": "1.2.1", + "version": "1.2.2", "description": "Prepend a one-line banner comment (with license notice) to distribution files", "license": "MIT", "type": "module", @@ -92,13 +92,13 @@ "devDependencies": { "@types/fancy-log": "~2.0", "@types/glob": "~8.1", - "@types/node": "~20.4", - "@typescript-eslint/eslint-plugin": "~6.2", - "@typescript-eslint/parser": "~6.2", + "@types/node": "~20.5", + "@typescript-eslint/eslint-plugin": "~6.4", + "@typescript-eslint/parser": "~6.4", "assert-deep-strict-equal": "~1.1", "copy-file-util": "~1.1", "copy-folder-util": "~1.1", - "eslint": "~8.46", + "eslint": "~8.47", "jshint": "~2.13", "mocha": "~10.2", "rimraf": "~5.0", diff --git a/spec/fixtures/target/cli/all/kebab.css b/spec/fixtures/target/cli/all/kebab.css index a0764d6..9a93d30 100644 --- a/spec/fixtures/target/cli/all/kebab.css +++ b/spec/fixtures/target/cli/all/kebab.css @@ -1,6 +1,6 @@ -/*! add-dist-header v1.2.1 ~~ https://github.com/center-key/add-dist-header ~~ MIT License */ +/*! add-dist-header v1.2.2 ~~ https://github.com/center-key/add-dist-header ~~ MIT License */ -.kebab { /* v1.2.1 */ +.kebab { /* v1.2.2 */ border: 2px solid firebrick; border-radius: 3px; } diff --git a/spec/fixtures/target/cli/all/kebab.html b/spec/fixtures/target/cli/all/kebab.html index 7108310..b4845cd 100644 --- a/spec/fixtures/target/cli/all/kebab.html +++ b/spec/fixtures/target/cli/all/kebab.html @@ -1,11 +1,11 @@ - + Kebab • 🍒🍒🍒 -

Kebab v1.2.1

+

Kebab v1.2.2

diff --git a/spec/fixtures/target/cli/all/kebab.js b/spec/fixtures/target/cli/all/kebab.js index 9ea66f4..a67e7b7 100644 --- a/spec/fixtures/target/cli/all/kebab.js +++ b/spec/fixtures/target/cli/all/kebab.js @@ -1,8 +1,8 @@ -//! add-dist-header v1.2.1 ~~ https://github.com/center-key/add-dist-header ~~ MIT License +//! add-dist-header v1.2.2 ~~ https://github.com/center-key/add-dist-header ~~ MIT License -const toKebab = (camelStr) => { //v1.2.1 +const toKebab = (camelStr) => { //v1.2.2 const dash = (word) => '-' + word.toLowerCase(); return ('' + camelStr).replace(/([A-Z]+)/g, dash).replace(/\s|^-/g, ''); }; -export { toKebab }; //version: 1.2.1 +export { toKebab }; //version: 1.2.2 diff --git a/spec/fixtures/target/cli/all/kebab.min.js b/spec/fixtures/target/cli/all/kebab.min.js index ab737a0..e8eca76 100644 --- a/spec/fixtures/target/cli/all/kebab.min.js +++ b/spec/fixtures/target/cli/all/kebab.min.js @@ -1,2 +1,2 @@ -//! add-dist-header v1.2.1 ~~ https://github.com/center-key/add-dist-header ~~ MIT License +//! add-dist-header v1.2.2 ~~ https://github.com/center-key/add-dist-header ~~ MIT License const toKebab=(c)=>{const d=(w)=>'-'+ w.toLowerCase();return(''+c).replace(/([A-Z]+)/g,d).replace(/\s|^-/g,'');};module.exports=toKebab; diff --git a/spec/fixtures/target/cli/all/kebab.ts b/spec/fixtures/target/cli/all/kebab.ts index 80bfcd3..7e63193 100644 --- a/spec/fixtures/target/cli/all/kebab.ts +++ b/spec/fixtures/target/cli/all/kebab.ts @@ -1,9 +1,9 @@ -//! add-dist-header v1.2.1 ~~ https://github.com/center-key/add-dist-header ~~ MIT License +//! add-dist-header v1.2.2 ~~ https://github.com/center-key/add-dist-header ~~ MIT License //! This comment is important! -const toKebab = (camelStr: string): string => { //v1.2.1 +const toKebab = (camelStr: string): string => { //v1.2.2 const dash = (word: string) => '-' + word.toLowerCase(); return ('' + camelStr).replace(/([A-Z]+)/g, dash).replace(/\s|^-/g, ''); }; -export { toKebab }; //version: 1.2.1 +export { toKebab }; //version: 1.2.2 diff --git a/spec/fixtures/target/cli/all/kebab.xml b/spec/fixtures/target/cli/all/kebab.xml index 68c4e0d..48bcd46 100644 --- a/spec/fixtures/target/cli/all/kebab.xml +++ b/spec/fixtures/target/cli/all/kebab.xml @@ -1,5 +1,5 @@ - + diff --git a/spec/fixtures/target/cli/all/subfolder/pita-bread.js b/spec/fixtures/target/cli/all/subfolder/pita-bread.js index 1439f14..78a3f5c 100644 --- a/spec/fixtures/target/cli/all/subfolder/pita-bread.js +++ b/spec/fixtures/target/cli/all/subfolder/pita-bread.js @@ -1,7 +1,7 @@ -//! add-dist-header v1.2.1 ~~ https://github.com/center-key/add-dist-header ~~ MIT License +//! add-dist-header v1.2.2 ~~ https://github.com/center-key/add-dist-header ~~ MIT License import { toKebab } from '../kebab'; -const pitaBread = (str) => `πŸ«“ ${toKebab(str)} πŸ«“`; //v1.2.1 +const pitaBread = (str) => `πŸ«“ ${toKebab(str)} πŸ«“`; //v1.2.2 export { pitaBread }; diff --git a/spec/fixtures/target/cli/ext/kebab.css b/spec/fixtures/target/cli/ext/kebab.css index a0764d6..9a93d30 100644 --- a/spec/fixtures/target/cli/ext/kebab.css +++ b/spec/fixtures/target/cli/ext/kebab.css @@ -1,6 +1,6 @@ -/*! add-dist-header v1.2.1 ~~ https://github.com/center-key/add-dist-header ~~ MIT License */ +/*! add-dist-header v1.2.2 ~~ https://github.com/center-key/add-dist-header ~~ MIT License */ -.kebab { /* v1.2.1 */ +.kebab { /* v1.2.2 */ border: 2px solid firebrick; border-radius: 3px; } diff --git a/spec/fixtures/target/cli/ext/kebab.js b/spec/fixtures/target/cli/ext/kebab.js index 9ea66f4..a67e7b7 100644 --- a/spec/fixtures/target/cli/ext/kebab.js +++ b/spec/fixtures/target/cli/ext/kebab.js @@ -1,8 +1,8 @@ -//! add-dist-header v1.2.1 ~~ https://github.com/center-key/add-dist-header ~~ MIT License +//! add-dist-header v1.2.2 ~~ https://github.com/center-key/add-dist-header ~~ MIT License -const toKebab = (camelStr) => { //v1.2.1 +const toKebab = (camelStr) => { //v1.2.2 const dash = (word) => '-' + word.toLowerCase(); return ('' + camelStr).replace(/([A-Z]+)/g, dash).replace(/\s|^-/g, ''); }; -export { toKebab }; //version: 1.2.1 +export { toKebab }; //version: 1.2.2 diff --git a/spec/fixtures/target/cli/ext/kebab.min.js b/spec/fixtures/target/cli/ext/kebab.min.js index ab737a0..e8eca76 100644 --- a/spec/fixtures/target/cli/ext/kebab.min.js +++ b/spec/fixtures/target/cli/ext/kebab.min.js @@ -1,2 +1,2 @@ -//! add-dist-header v1.2.1 ~~ https://github.com/center-key/add-dist-header ~~ MIT License +//! add-dist-header v1.2.2 ~~ https://github.com/center-key/add-dist-header ~~ MIT License const toKebab=(c)=>{const d=(w)=>'-'+ w.toLowerCase();return(''+c).replace(/([A-Z]+)/g,d).replace(/\s|^-/g,'');};module.exports=toKebab; diff --git a/spec/fixtures/target/kebab.html b/spec/fixtures/target/kebab.html index 18f512f..7a9170e 100644 --- a/spec/fixtures/target/kebab.html +++ b/spec/fixtures/target/kebab.html @@ -1,4 +1,4 @@ - + @@ -7,6 +7,6 @@ Kebab • 🍒🍒🍒 -

Kebab v1.2.1

+

Kebab v1.2.2

diff --git a/spec/fixtures/target/kebab.js b/spec/fixtures/target/kebab.js index 200e8ce..6309dbe 100644 --- a/spec/fixtures/target/kebab.js +++ b/spec/fixtures/target/kebab.js @@ -1,8 +1,8 @@ -//! add-dist-header v1.2.1 πŸ«“πŸ’πŸ«“ https://github.com/center-key/add-dist-header πŸ«“πŸ’πŸ«“ MIT License +//! add-dist-header v1.2.2 πŸ«“πŸ’πŸ«“ https://github.com/center-key/add-dist-header πŸ«“πŸ’πŸ«“ MIT License -const toKebab = (camelStr) => { //v1.2.1 +const toKebab = (camelStr) => { //v1.2.2 const dash = (word) => '-' + word.toLowerCase(); return ('' + camelStr).replace(/([A-Z]+)/g, dash).replace(/\s|^-/g, ''); }; -export { toKebab }; //version: 1.2.1 +export { toKebab }; //version: 1.2.2 diff --git a/spec/fixtures/target/kebab.min.css b/spec/fixtures/target/kebab.min.css index 09cda3f..bec2e80 100644 --- a/spec/fixtures/target/kebab.min.css +++ b/spec/fixtures/target/kebab.min.css @@ -1,5 +1,5 @@ -/*! add-dist-header v1.2.1 ~~ https://github.com/center-key/add-dist-header ~~ MIT License */ -.kebab { /* v1.2.1 */ +/*! add-dist-header v1.2.2 ~~ https://github.com/center-key/add-dist-header ~~ MIT License */ +.kebab { /* v1.2.2 */ border: 2px solid firebrick; border-radius: 3px; } diff --git a/spec/fixtures/target/kebab.min.js b/spec/fixtures/target/kebab.min.js index ab737a0..e8eca76 100644 --- a/spec/fixtures/target/kebab.min.js +++ b/spec/fixtures/target/kebab.min.js @@ -1,2 +1,2 @@ -//! add-dist-header v1.2.1 ~~ https://github.com/center-key/add-dist-header ~~ MIT License +//! add-dist-header v1.2.2 ~~ https://github.com/center-key/add-dist-header ~~ MIT License const toKebab=(c)=>{const d=(w)=>'-'+ w.toLowerCase();return(''+c).replace(/([A-Z]+)/g,d).replace(/\s|^-/g,'');};module.exports=toKebab; diff --git a/spec/fixtures/target/kebab.ts b/spec/fixtures/target/kebab.ts index 8e77c95..3fd424e 100644 --- a/spec/fixtures/target/kebab.ts +++ b/spec/fixtures/target/kebab.ts @@ -1,4 +1,4 @@ -//! add-dist-header v1.2.1 ~~ https://github.com/center-key/add-dist-header ~~ MIT License +//! add-dist-header v1.2.2 ~~ https://github.com/center-key/add-dist-header ~~ MIT License //! This comment is important! const toKebab = (camelStr: string): string => { //v{{pkg.version}}