Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
remark-lint-no-file-name-outer-dashes
Advanced tools
remark-lint-no-file-name-outer-dashes - npm Package Compare versions
Comparing version 2.1.0 to 2.1.1
| export default remarkLintNofileNameOuterDashes | ||
| export type Root = import('mdast').Root | ||
| declare const remarkLintNofileNameOuterDashes: import('unified').Plugin< | ||
| | void[] | ||
| | [unknown] | ||
| | void[] | ||
| | [ | ||
| ( | ||
| | boolean | ||
| | import('unified-lint-rule').Label | ||
| | import('unified-lint-rule').Severity | ||
| | import('unified-lint-rule').Label | ||
| ), | ||
@@ -12,0 +12,0 @@ unknown |
16
index.js
| /** | ||
| * ## When should I use this? | ||
| * | ||
| * You can use this package to check that no initial or final dashes appear in | ||
| * file names. | ||
| * | ||
| * ## API | ||
| * | ||
| * There are no options. | ||
| * | ||
| * @module no-file-name-outer-dashes | ||
| * @summary | ||
| * remark-lint rule to warn when initial or final dashes appear in file names. | ||
| * @author Titus Wormer | ||
| * @copyright 2015 Titus Wormer | ||
| * @license MIT | ||
| * @module no-file-name-outer-dashes | ||
| * @fileoverview | ||
| * Warn when file names contain initial or final dashes (hyphen-minus, `-`). | ||
| * | ||
| * @example | ||
@@ -10,0 +18,0 @@ * {"name": "readme.md"} |
| { | ||
| "name": "remark-lint-no-file-name-outer-dashes", | ||
| "version": "2.1.0", | ||
| "version": "2.1.1", | ||
| "description": "remark-lint rule to warn when file names contain initial or final dashes", | ||
@@ -5,0 +5,0 @@ "license": "MIT", |
157
readme.md
@@ -13,4 +13,29 @@ <!--This file is generated--> | ||
| Warn when file names contain initial or final dashes (hyphen-minus, `-`). | ||
| [`remark-lint`][mono] rule to warn when initial or final dashes appear in file names. | ||
| ## Contents | ||
| * [What is this?](#what-is-this) | ||
| * [When should I use this?](#when-should-i-use-this) | ||
| * [Presets](#presets) | ||
| * [Install](#install) | ||
| * [Use](#use) | ||
| * [API](#api) | ||
| * [`unified().use(remarkLintNoFileNameOuterDashes[, config])`](#unifieduseremarklintnofilenameouterdashes-config) | ||
| * [Examples](#examples) | ||
| * [Compatibility](#compatibility) | ||
| * [Contribute](#contribute) | ||
| * [License](#license) | ||
| ## What is this? | ||
| This package is a [unified][] ([remark][]) plugin, specifically a `remark-lint` | ||
| rule. | ||
| Lint rules check markdown code style. | ||
| ## When should I use this? | ||
| You can use this package to check that no initial or final dashes appear in | ||
| file names. | ||
| ## Presets | ||
@@ -24,44 +49,56 @@ | ||
| ## Example | ||
| ## Install | ||
| ##### `readme.md` | ||
| This package is [ESM only][esm]. | ||
| In Node.js (version 12.20+, 14.14+, or 16.0+), install with [npm][]: | ||
| ###### Out | ||
| ```sh | ||
| npm install remark-lint-no-file-name-outer-dashes | ||
| ``` | ||
| No messages. | ||
| In Deno with [Skypack][]: | ||
| ##### `-readme.md` | ||
| ```js | ||
| import remarkLintNoFileNameOuterDashes from 'https://cdn.skypack.dev/remark-lint-no-file-name-outer-dashes@2?dts' | ||
| ``` | ||
| ###### Out | ||
| In browsers with [Skypack][]: | ||
| ```text | ||
| 1:1: Do not use initial or final dashes in a file name | ||
| ```html | ||
| <script type="module"> | ||
| import remarkLintNoFileNameOuterDashes from 'https://cdn.skypack.dev/remark-lint-no-file-name-outer-dashes@2?min' | ||
| </script> | ||
| ``` | ||
| ##### `readme-.md` | ||
| ## Use | ||
| ###### Out | ||
| On the API: | ||
| ```text | ||
| 1:1: Do not use initial or final dashes in a file name | ||
| ``` | ||
| ```js | ||
| import {read} from 'to-vfile' | ||
| import {reporter} from 'vfile-reporter' | ||
| import {remark} from 'remark' | ||
| import remarkLint from 'remark-lint' | ||
| import remarkLintNoFileNameOuterDashes from 'remark-lint-no-file-name-outer-dashes' | ||
| ## Install | ||
| main() | ||
| This package is [ESM only][esm]: | ||
| Node 12+ is needed to use it and it must be `imported`ed instead of `required`d. | ||
| async function main() { | ||
| const file = await remark() | ||
| .use(remarkLint) | ||
| .use(remarkLintNoFileNameOuterDashes) | ||
| .process(await read('example.md')) | ||
| [npm][]: | ||
| console.error(reporter(file)) | ||
| } | ||
| ``` | ||
| On the CLI: | ||
| ```sh | ||
| npm install remark-lint-no-file-name-outer-dashes | ||
| remark --use remark-lint --use remark-lint-no-file-name-outer-dashes example.md | ||
| ``` | ||
| This package exports no identifiers. | ||
| The default export is `remarkLintNoFileNameOuterDashes`. | ||
| On the CLI in a config file (here a `package.json`): | ||
| ## Use | ||
| You probably want to use it on the CLI through a config file: | ||
| ```diff | ||
@@ -72,4 +109,4 @@ … | ||
| … | ||
| "lint", | ||
| + "lint-no-file-name-outer-dashes", | ||
| "remark-lint", | ||
| + "remark-lint-no-file-name-outer-dashes", | ||
| … | ||
@@ -81,25 +118,45 @@ ] | ||
| Or use it on the CLI directly | ||
| ## API | ||
| ```sh | ||
| remark -u lint -u lint-no-file-name-outer-dashes readme.md | ||
| This package exports no identifiers. | ||
| The default export is `remarkLintNoFileNameOuterDashes`. | ||
| ### `unified().use(remarkLintNoFileNameOuterDashes[, config])` | ||
| This rule supports standard configuration that all remark lint rules accept | ||
| (such as `false` to turn it off or `[1, options]` to configure it). | ||
| There are no options. | ||
| ## Examples | ||
| ##### `readme.md` | ||
| ###### Out | ||
| No messages. | ||
| ##### `-readme.md` | ||
| ###### Out | ||
| ```text | ||
| 1:1: Do not use initial or final dashes in a file name | ||
| ``` | ||
| Or use this on the API: | ||
| ##### `readme-.md` | ||
| ```diff | ||
| import {remark} from 'remark' | ||
| import {reporter} from 'vfile-reporter' | ||
| import remarkLint from 'remark-lint' | ||
| import remarkLintNoFileNameOuterDashes from 'remark-lint-no-file-name-outer-dashes' | ||
| ###### Out | ||
| remark() | ||
| .use(remarkLint) | ||
| + .use(remarkLintNoFileNameOuterDashes) | ||
| .process('_Emphasis_ and **importance**') | ||
| .then((file) => { | ||
| console.error(reporter(file)) | ||
| }) | ||
| ```text | ||
| 1:1: Do not use initial or final dashes in a file name | ||
| ``` | ||
| ## Compatibility | ||
| Projects maintained by the unified collective are compatible with all maintained | ||
| versions of Node.js. | ||
| As of now, that is Node.js 12.20+, 14.14+, and 16.0+. | ||
| Our projects sometimes work with older versions, but this is not guaranteed. | ||
| ## Contribute | ||
@@ -145,4 +202,12 @@ | ||
| [unified]: https://github.com/unifiedjs/unified | ||
| [remark]: https://github.com/remarkjs/remark | ||
| [mono]: https://github.com/remarkjs/remark-lint | ||
| [esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c | ||
| [skypack]: https://www.skypack.dev | ||
| [npm]: https://docs.npmjs.com/cli/install | ||
@@ -152,7 +217,7 @@ | ||
| [contributing]: https://github.com/remarkjs/.github/blob/HEAD/contributing.md | ||
| [contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md | ||
| [support]: https://github.com/remarkjs/.github/blob/HEAD/support.md | ||
| [support]: https://github.com/remarkjs/.github/blob/main/support.md | ||
| [coc]: https://github.com/remarkjs/.github/blob/HEAD/code-of-conduct.md | ||
| [coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md | ||
@@ -159,0 +224,0 @@ [license]: https://github.com/remarkjs/remark-lint/blob/main/license |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by29.16%
8389
- Lines of code
- increased by14.81%
62
- Number of lines in readme file
- increased by41.67%
221
No dependency changes