embedex 0.3.2 → 0.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/package.json +2 -2
- package/src/bin/cli.js +1 -1
package/README.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# embedex <!-- omit from toc -->
|
|
2
2
|
|
|
3
|
-
Embed shared text and code snippets from source files into destination files. For example:
|
|
3
|
+
Embed shared text and code snippets from source files into destination files that appear on hover in IDEs. For example:
|
|
4
4
|
|
|
5
5
|
- Embed TypeScript examples into TypeDoc comments and your README.
|
|
6
6
|
- Embed a Markdown snippet into multiple JSDoc comments.
|
|
7
7
|
|
|
8
|
-
`embedex` helps ensure a single source of truth while
|
|
8
|
+
`embedex` helps ensure a single source of truth while keeping sources runnable, linted, tested, and up-to-date with the code they are documenting.
|
|
9
9
|
|
|
10
10
|
## Table of contents <!-- omit from toc -->
|
|
11
11
|
|
|
@@ -119,7 +119,7 @@ Embed shared text and code snippets from source files into destination files.
|
|
|
119
119
|
|
|
120
120
|
Options:
|
|
121
121
|
-V, --version output the version number
|
|
122
|
-
-
|
|
122
|
+
-s, --sourcesGlob <pattern> sources glob pattern (default: "examples/**/*.{md,ts}")
|
|
123
123
|
-c, --check verify if sources are correctly embedded without making changes,
|
|
124
124
|
exits with non-zero code if updates are needed; useful for CI/CD
|
|
125
125
|
pipelines (default: false)
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "embedex",
|
|
3
3
|
"description": "Embed shared text and code snippets from source files into destination files.",
|
|
4
|
-
"version": "0.3.
|
|
4
|
+
"version": "0.3.3",
|
|
5
5
|
"bin": {
|
|
6
6
|
"embedex": "./src/bin/cli.js"
|
|
7
7
|
},
|
|
8
8
|
"bugs": "https://github.com/ClipboardHealth/core-utils/issues",
|
|
9
9
|
"dependencies": {
|
|
10
|
-
"@commander-js/extra-typings": "
|
|
10
|
+
"@commander-js/extra-typings": "13.0.0",
|
|
11
11
|
"glob": "11.0.0",
|
|
12
12
|
"tslib": "2.8.0",
|
|
13
13
|
"yoctocolors-cjs": "2.1.2"
|
package/src/bin/cli.js
CHANGED
|
@@ -9,7 +9,7 @@ const program = new extra_typings_1.Command()
|
|
|
9
9
|
.name(package_json_1.name)
|
|
10
10
|
.description(package_json_1.description)
|
|
11
11
|
.version(String(package_json_1.version))
|
|
12
|
-
.addOption(new extra_typings_1.Option("-
|
|
12
|
+
.addOption(new extra_typings_1.Option("-s, --sourcesGlob <pattern>", "sources glob pattern").default("examples/**/*.{md,ts}"))
|
|
13
13
|
.addOption(new extra_typings_1.Option("-c, --check", "verify if sources are correctly embedded without making changes, exits with non-zero code if updates are needed; useful for CI/CD pipelines").default(false))
|
|
14
14
|
.addOption(new extra_typings_1.Option("-v, --verbose", "show verbose output").default(false));
|
|
15
15
|
program.parse();
|