You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP →
remark-lint-fenced-code-flag
Advanced tools
remark-lint-fenced-code-flag - npm Package Compare versions
Comparing version 3.1.0 to 3.1.1
| export default remarkLintFencedCodeFlag | ||
| export type Root = import('mdast').Root | ||
| export type Flags = string[] | ||
| export type Flags = Array<string> | ||
| export type FlagMap = { | ||
@@ -12,5 +12,5 @@ flags?: Flags | undefined | ||
| | [ | ||
| | Options | ||
| | import('unified-lint-rule').Label | ||
| | import('unified-lint-rule').Severity | ||
| | import('unified-lint-rule').Label | ||
| | Options | ||
| ] | ||
@@ -20,4 +20,4 @@ | [ | ||
| | boolean | ||
| | import('unified-lint-rule').Label | ||
| | import('unified-lint-rule').Severity | ||
| | import('unified-lint-rule').Label | ||
| ), | ||
@@ -24,0 +24,0 @@ Options |
43
index.js
| /** | ||
| * ## When should I use this? | ||
| * | ||
| * You can use this package to check that language flags of fenced code | ||
| * are used and consistent. | ||
| * | ||
| * ## API | ||
| * | ||
| * The following options (default: `undefined`) are accepted: | ||
| * | ||
| * * `Array<string>` | ||
| * — as if passing `{flags: options}` | ||
| * * `Object` with the following fields: | ||
| * * `allowEmpty` (`boolean`, default: `false`) | ||
| * — allow language flags to be omitted | ||
| * * `flags` (`Array<string>` default: `[]`) | ||
| * — specific flags to allow (other flags will result in a warning) | ||
| * | ||
| * ## Recommendation | ||
| * | ||
| * While omitting the language flag is perfectly fine to signal that the code is | ||
| * plain text, it *could* point to a mistake. | ||
| * It’s recommended to instead use a certain flag for plain text (such as `txt`) | ||
| * and to turn this rule on. | ||
| * | ||
| * @module fenced-code-flag | ||
| * @summary | ||
| * remark-lint rule to check that language flags of fenced code are used. | ||
| * @author Titus Wormer | ||
| * @copyright 2015 Titus Wormer | ||
| * @license MIT | ||
| * @module fenced-code-flag | ||
| * @fileoverview | ||
| * Check fenced code block flags. | ||
| * | ||
| * Options: `Array.<string>` or `Object`, optional. | ||
| * | ||
| * Providing an array is as passing `{flags: Array}`. | ||
| * | ||
| * The object can have an array of `'flags'` which are allowed: other flags | ||
| * will not be allowed. | ||
| * An `allowEmpty` field (`boolean`, default: `false`) can be set to allow | ||
| * code blocks without language flags. | ||
| * | ||
| * @example | ||
@@ -86,3 +101,3 @@ * {"name": "ok.md"} | ||
| * | ||
| * @typedef {string[]} Flags | ||
| * @typedef {Array<string>} Flags | ||
| * | ||
@@ -112,3 +127,3 @@ * @typedef FlagMap | ||
| let allowEmpty = false | ||
| /** @type {string[]} */ | ||
| /** @type {Array<string>} */ | ||
| let allowed = [] | ||
@@ -115,0 +130,0 @@ |
| { | ||
| "name": "remark-lint-fenced-code-flag", | ||
| "version": "3.1.0", | ||
| "version": "3.1.1", | ||
| "description": "remark-lint rule to warn when fenced code blocks occur without language flag", | ||
@@ -5,0 +5,0 @@ "license": "MIT", |
198
readme.md
@@ -13,13 +13,30 @@ <!--This file is generated--> | ||
| Check fenced code block flags. | ||
| [`remark-lint`][mono] rule to check that language flags of fenced code are used. | ||
| Options: `Array.<string>` or `Object`, optional. | ||
| ## Contents | ||
| Providing an array is as passing `{flags: Array}`. | ||
| * [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(remarkLintFencedCodeFlag[, config])`](#unifieduseremarklintfencedcodeflag-config) | ||
| * [Recommendation](#recommendation) | ||
| * [Examples](#examples) | ||
| * [Compatibility](#compatibility) | ||
| * [Contribute](#contribute) | ||
| * [License](#license) | ||
| The object can have an array of `'flags'` which are allowed: other flags | ||
| will not be allowed. | ||
| An `allowEmpty` field (`boolean`, default: `false`) can be set to allow | ||
| code blocks without language flags. | ||
| ## 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 language flags of fenced code | ||
| are used and consistent. | ||
| ## Presets | ||
@@ -33,4 +50,98 @@ | ||
| ## Example | ||
| ## Install | ||
| This package is [ESM only][esm]. | ||
| In Node.js (version 12.20+, 14.14+, or 16.0+), install with [npm][]: | ||
| ```sh | ||
| npm install remark-lint-fenced-code-flag | ||
| ``` | ||
| In Deno with [Skypack][]: | ||
| ```js | ||
| import remarkLintFencedCodeFlag from 'https://cdn.skypack.dev/remark-lint-fenced-code-flag@3?dts' | ||
| ``` | ||
| In browsers with [Skypack][]: | ||
| ```html | ||
| <script type="module"> | ||
| import remarkLintFencedCodeFlag from 'https://cdn.skypack.dev/remark-lint-fenced-code-flag@3?min' | ||
| </script> | ||
| ``` | ||
| ## Use | ||
| On the API: | ||
| ```js | ||
| import {read} from 'to-vfile' | ||
| import {reporter} from 'vfile-reporter' | ||
| import {remark} from 'remark' | ||
| import remarkLint from 'remark-lint' | ||
| import remarkLintFencedCodeFlag from 'remark-lint-fenced-code-flag' | ||
| main() | ||
| async function main() { | ||
| const file = await remark() | ||
| .use(remarkLint) | ||
| .use(remarkLintFencedCodeFlag) | ||
| .process(await read('example.md')) | ||
| console.error(reporter(file)) | ||
| } | ||
| ``` | ||
| On the CLI: | ||
| ```sh | ||
| remark --use remark-lint --use remark-lint-fenced-code-flag example.md | ||
| ``` | ||
| On the CLI in a config file (here a `package.json`): | ||
| ```diff | ||
| … | ||
| "remarkConfig": { | ||
| "plugins": [ | ||
| … | ||
| "remark-lint", | ||
| + "remark-lint-fenced-code-flag", | ||
| … | ||
| ] | ||
| } | ||
| … | ||
| ``` | ||
| ## API | ||
| This package exports no identifiers. | ||
| The default export is `remarkLintFencedCodeFlag`. | ||
| ### `unified().use(remarkLintFencedCodeFlag[, 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). | ||
| The following options (default: `undefined`) are accepted: | ||
| * `Array<string>` | ||
| — as if passing `{flags: options}` | ||
| * `Object` with the following fields: | ||
| * `allowEmpty` (`boolean`, default: `false`) | ||
| — allow language flags to be omitted | ||
| * `flags` (`Array<string>` default: `[]`) | ||
| — specific flags to allow (other flags will result in a warning) | ||
| ## Recommendation | ||
| While omitting the language flag is perfectly fine to signal that the code is | ||
| plain text, it *could* point to a mistake. | ||
| It’s recommended to instead use a certain flag for plain text (such as `txt`) | ||
| and to turn this rule on. | ||
| ## Examples | ||
| ##### `ok.md` | ||
@@ -150,56 +261,9 @@ | ||
| ## Install | ||
| ## Compatibility | ||
| This package is [ESM only][esm]: | ||
| Node 12+ is needed to use it and it must be `imported`ed instead of `required`d. | ||
| 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. | ||
| [npm][]: | ||
| ```sh | ||
| npm install remark-lint-fenced-code-flag | ||
| ``` | ||
| This package exports no identifiers. | ||
| The default export is `remarkLintFencedCodeFlag`. | ||
| ## Use | ||
| You probably want to use it on the CLI through a config file: | ||
| ```diff | ||
| … | ||
| "remarkConfig": { | ||
| "plugins": [ | ||
| … | ||
| "lint", | ||
| + "lint-fenced-code-flag", | ||
| … | ||
| ] | ||
| } | ||
| … | ||
| ``` | ||
| Or use it on the CLI directly | ||
| ```sh | ||
| remark -u lint -u lint-fenced-code-flag readme.md | ||
| ``` | ||
| Or use this on the API: | ||
| ```diff | ||
| import {remark} from 'remark' | ||
| import {reporter} from 'vfile-reporter' | ||
| import remarkLint from 'remark-lint' | ||
| import remarkLintFencedCodeFlag from 'remark-lint-fenced-code-flag' | ||
| remark() | ||
| .use(remarkLint) | ||
| + .use(remarkLintFencedCodeFlag) | ||
| .process('_Emphasis_ and **importance**') | ||
| .then((file) => { | ||
| console.error(reporter(file)) | ||
| }) | ||
| ``` | ||
| ## Contribute | ||
@@ -245,4 +309,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 | ||
@@ -252,7 +324,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 | ||
@@ -259,0 +331,0 @@ [license]: https://github.com/remarkjs/remark-lint/blob/main/license |
No alert changes
Improved metrics
- Total package byte prevSize
12481
26.25%- Lines of code
179
9.15%- Number of lines in readme file
329
28.02%No dependency changes