diff --git a/README.md b/README.md index f677800..28f88b5 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ yarn global add @electron/lint-roller electron-markdownlint "**/*.md" -electron-lint-markdown-links --root docs/ "docs/**/*.md" +lint-roller-markdown-links --root docs/ "docs/**/*.md" ``` ## What It Provides @@ -28,11 +28,11 @@ across repos. To use the base config, extend it in `.markdownlint.json`: `electron-markdownlint` is provided as a wrapper command which adds extra rules found in this package automatically. -`electron-lint-markdown-links` is a command to further lint links to find +`lint-roller-markdown-links` is a command to further lint links to find broken relative links, including URL fragments, and can also be used to check external links with the `--fetch-external-links` option. -`electron-lint-markdown-standard` is a command to lint JS code blocks in +`lint-roller-markdown-standard` is a command to lint JS code blocks in Markdown with `standard`, like `standard-markdown` does, but with better detection of code blocks. Linting can be disabled for specific code blocks by adding `@nolint` to the info string. diff --git a/bin/lint-markdown-links.ts b/bin/lint-markdown-links.ts index fbf455c..444577f 100644 --- a/bin/lint-markdown-links.ts +++ b/bin/lint-markdown-links.ts @@ -147,7 +147,7 @@ function parseCommandLine() { const showUsage = (arg?: string): boolean => { if (!arg || arg.startsWith('-')) { console.log( - 'Usage: electron-lint-markdown-links [--root ] [-h|--help] [--fetch-external-links] ' + + 'Usage: lint-roller-markdown-links [--root ] [-h|--help] [--fetch-external-links] ' + '[--check-redirects] [--ignore ]', ); process.exit(1); diff --git a/bin/lint-markdown-standard.ts b/bin/lint-markdown-standard.ts index d975f5c..b064bff 100644 --- a/bin/lint-markdown-standard.ts +++ b/bin/lint-markdown-standard.ts @@ -170,7 +170,7 @@ function parseCommandLine() { const showUsage = (arg?: string): boolean => { if (!arg || arg.startsWith('-')) { console.log( - 'Usage: electron-lint-markdown-standard [--root ] [-h|--help] [--fix]' + + 'Usage: lint-roller-markdown-standard [--root ] [-h|--help] [--fix]' + '[--ignore ] [--ignore-path ] [--semi]', ); process.exit(1); diff --git a/package.json b/package.json index 0cd7143..ce878dd 100644 --- a/package.json +++ b/package.json @@ -7,8 +7,8 @@ }, "bin": { "electron-markdownlint": "./dist/bin/markdownlint-cli-wrapper.js", - "electron-lint-markdown-links": "./dist/bin/lint-markdown-links.js", - "electron-lint-markdown-standard": "./dist/bin/lint-markdown-standard.js", + "lint-roller-markdown-links": "./dist/bin/lint-markdown-links.js", + "lint-roller-markdown-standard": "./dist/bin/lint-markdown-standard.js", "lint-roller-markdown-ts-check": "./dist/bin/lint-markdown-ts-check.js" }, "files": [ diff --git a/tests/__snapshots__/electron-lint-markdown-standard.spec.ts.snap b/tests/__snapshots__/lint-roller-markdown-standard.spec.ts.snap similarity index 93% rename from tests/__snapshots__/electron-lint-markdown-standard.spec.ts.snap rename to tests/__snapshots__/lint-roller-markdown-standard.spec.ts.snap index 2bcfd9c..3191459 100644 --- a/tests/__snapshots__/electron-lint-markdown-standard.spec.ts.snap +++ b/tests/__snapshots__/lint-roller-markdown-standard.spec.ts.snap @@ -1,6 +1,6 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`electron-lint-markdown-standard can detect errors in code blocks 1`] = ` +exports[`lint-roller-markdown-standard can detect errors in code blocks 1`] = ` " dirty.md 6:1: Unexpected var, use let or const instead. @@ -28,7 +28,7 @@ There are 20 errors in '' " `; -exports[`electron-lint-markdown-standard can fix cleanable errors with --fix option 1`] = ` +exports[`lint-roller-markdown-standard can fix cleanable errors with --fix option 1`] = ` "# The Cleanable Readme This is a markdown file with some javascript code blocks in it. @@ -105,7 +105,7 @@ and wrapped arrays: " `; -exports[`electron-lint-markdown-standard outputs uncleanable errors with --fix option 1`] = ` +exports[`lint-roller-markdown-standard outputs uncleanable errors with --fix option 1`] = ` "# The Dirty Readme This is a markdown file with some javascript code blocks in it. diff --git a/tests/electron-lint-markdown-links.spec.ts b/tests/lint-roller-markdown-links.spec.ts similarity index 98% rename from tests/electron-lint-markdown-links.spec.ts rename to tests/lint-roller-markdown-links.spec.ts index f72c815..a03cd84 100644 --- a/tests/electron-lint-markdown-links.spec.ts +++ b/tests/lint-roller-markdown-links.spec.ts @@ -11,7 +11,7 @@ function runLintMarkdownLinks(...args: string[]) { ); } -describe('electron-lint-markdown-links', () => { +describe('lint-roller-markdown-links', () => { it('should catch broken internal links', () => { const { status, stdout } = runLintMarkdownLinks( '--root', diff --git a/tests/electron-lint-markdown-standard.spec.ts b/tests/lint-roller-markdown-standard.spec.ts similarity index 98% rename from tests/electron-lint-markdown-standard.spec.ts rename to tests/lint-roller-markdown-standard.spec.ts index 5af8f28..3f3461b 100644 --- a/tests/electron-lint-markdown-standard.spec.ts +++ b/tests/lint-roller-markdown-standard.spec.ts @@ -13,7 +13,7 @@ function runLintMarkdownStandard(...args: string[]) { ); } -describe('electron-lint-markdown-standard', () => { +describe('lint-roller-markdown-standard', () => { it('should run clean when there are no errors', () => { const { status } = runLintMarkdownStandard('--root', FIXTURES_DIR, 'clean.md');