Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-12-16 14:00:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

wip

Browse source
This commit is contained in:
David Anson 2025-11-24 13:58:48 -08:00
parent 4447540366
commit 3ea07a7614
15 changed files with 15 additions and 363 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/Rules.md
View file

@ -2696,8 +2696,6 @@ Parameters:
- `style`: Table column style (`string`, default `any`, values `aligned` /
`any` / `compact` / `tight`)
- `wide_character`: RegExp for matching wide character(s) (`string`, default
`TBD`)
This rule is triggered when the column separators of a
[GitHub Flavored Markdown table][gfm-table-060] are used inconsistently.

2
doc/md060.md
View file

@ -8,8 +8,6 @@ Parameters:
- `style`: Table column style (`string`, default `any`, values `aligned` /
`any` / `compact` / `tight`)
- `wide_character`: RegExp for matching wide character(s) (`string`, default
`TBD`)
This rule is triggered when the column separators of a
[GitHub Flavored Markdown table][gfm-table-060] are used inconsistently.

8
lib/configuration-strict.d.ts vendored
View file

@ -2281,10 +2281,6 @@ export interface ConfigurationStrict {
* Table column style
*/
style?: "any" | "aligned" | "compact" | "tight";
/**
* RegExp for matching wide character(s)
*/
wide_character?: string;
};
/**
* MD060/table-column-style : Table column style : https://github.com/DavidAnson/markdownlint/blob/v0.39.0/doc/md060.md
@ -2305,10 +2301,6 @@ export interface ConfigurationStrict {
* Table column style
*/
style?: "any" | "aligned" | "compact" | "tight";
/**
* RegExp for matching wide character(s)
*/
wide_character?: string;
};
/**
* headings : MD001, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043

45
lib/md060.mjs
View file

@ -2,58 +2,34 @@
import { filterByTypes } from "../helpers/micromark-helpers.cjs";
import { filterByTypesCached } from "./cache.mjs";
import stringWidth from "string-width";
/** @typedef {import("micromark-extension-gfm-table")} */
/** @typedef {import("markdownlint").MicromarkToken} MicromarkToken */
/** @typedef {import("markdownlint").RuleOnErrorInfo} RuleOnErrorInfo */
const regExpFlags = "gv";
const anyCharacterRe = new RegExp("[\\s\\S]", regExpFlags);
// See:
// https://www.unicode.org/reports/tr11/
// https://unicode.org/reports/tr24/
// https://unicode.org/reports/tr51/
// https://util.unicode.org/UnicodeJsps/list-unicodeset.jsp?a=%5B%3AEast_Asian_Width%3DFullwidth%3A%5D&abb=on&esc=on&g=&i=
// Notes:
// The East_Asian_Width property is not supported (seemingly at all) by JavaScript, so East_Asian_Width=Fullwidth ranges are matched directly:
// https://github.com/tc39/proposal-regexp-unicode-property-escapes/issues/28
// As an alternative to matching by Script names, consider matching East_Asian_Width=Wide (Wide is a superset of Fullwidth) directly as well:
// https://util.unicode.org/UnicodeJsps/list-unicodeset.jsp?a=%5B%3AEast_Asian_Width%3DWide%3A%5D&abb=on&esc=on&g=&i=
const defaultWideCharacterReString = "[\\p{RGI_Emoji}\\p{Script=Han}\\p{Script=Hiragana}\\p{Script=Katakana}\\p{Script=Hangul}\\u3000\\uFF01-\\uFF60\\uFFE0-\\uFFE6]";
/**
* @typedef Column
* @property {number} actual Actual column (1-based)
* @property {number} effective Effective column (1-based)
*/
/**
* Gets the effective (adjusted for wide characters) column for an actual column.
*
* @param {string} line Line of text.
* @param {number} column Actual column (1-based).
* @param {RegExp} wideCharacterRe Wide character RegExp.
* @returns {number} Effective column (1-based).
*/
function effectiveColumn(line, column, wideCharacterRe) {
const span = line.slice(0, column - 1);
const totalCharacterCount = (span.match(anyCharacterRe) || []).length;
const wideCharacterCount = (span.match(wideCharacterRe) || []).length;
return totalCharacterCount + wideCharacterCount;
}
/**
* Gets a list of table cell divider columns.
*
* @param {readonly string[]} lines File/string lines.
* @param {MicromarkToken} row Micromark row token.
* @param {RegExp} wideCharacterRe Wide character RegExp.
* @returns {Column[]} Divider columns.
*/
function getTableDividerColumns(lines, row, wideCharacterRe) {
function getTableDividerColumns(lines, row) {
return filterByTypes(
row.children,
[ "tableCellDivider" ]).map((divider) => ({ "actual": divider.startColumn, "effective": effectiveColumn(lines[row.startLine - 1], divider.startColumn, wideCharacterRe) })
[ "tableCellDivider" ]
).map(
(divider) => ({
"actual": divider.startColumn,
"effective": stringWidth(lines[row.startLine - 1].slice(0, divider.startColumn - 1))
})
);
}
@ -84,7 +60,6 @@ export default {
const styleAlignedAllowed = (style === "any") || (style === "aligned");
const styleCompactAllowed = (style === "any") || (style === "compact");
const styleTightAllowed = (style === "any") || (style === "tight");
const wideCharacterRe = new RegExp(params.config.wide_character || defaultWideCharacterReString, regExpFlags);
// Scan all tables/rows
const tables = filterByTypesCached([ "table" ]);
@ -96,10 +71,10 @@ export default {
/** @type {RuleOnErrorInfo[]} */
const errorsIfAligned = [];
if (styleAlignedAllowed) {
const headingDividerColumns = getTableDividerColumns(params.lines, headingRow, wideCharacterRe);
const headingDividerColumns = getTableDividerColumns(params.lines, headingRow);
for (const row of rows.slice(1)) {
const remainingHeadingDividerColumns = new Set(headingDividerColumns.map((column) => column.effective));
const rowDividerColumns = getTableDividerColumns(params.lines, row, wideCharacterRe);
const rowDividerColumns = getTableDividerColumns(params.lines, row);
for (const dividerColumn of rowDividerColumns) {
if ((remainingHeadingDividerColumns.size > 0) && !remainingHeadingDividerColumns.delete(dividerColumn.effective)) {
addError(errorsIfAligned, row.startLine, dividerColumn.actual, "Table pipe does not align with heading for style \"aligned\"");

5
package.json
View file

@ -36,7 +36,7 @@
"build-config": "npm run build-config-schema && npm run build-config-example",
"build-config-example": "node schema/build-config-example.mjs",
"build-config-schema": "node schema/build-config-schema.mjs",
"build-declaration": "tsc --allowJs --checkJs --declaration --emitDeclarationOnly --module nodenext --outDir dts --rootDir . --target es2024 lib/exports.mjs lib/exports-async.mjs lib/exports-promise.mjs lib/exports-sync.mjs lib/markdownlint.mjs lib/resolve-module.cjs && node scripts/index.mjs copy dts/lib/exports.d.mts lib/exports.d.mts && node scripts/index.mjs copy dts/lib/exports-async.d.mts lib/exports-async.d.mts && node scripts/index.mjs copy dts/lib/exports-promise.d.mts lib/exports-promise.d.mts && node scripts/index.mjs copy dts/lib/exports-sync.d.mts lib/exports-sync.d.mts && node scripts/index.mjs copy dts/lib/markdownlint.d.mts lib/markdownlint.d.mts && node scripts/index.mjs copy dts/lib/resolve-module.d.cts lib/resolve-module.d.cts && node scripts/index.mjs remove dts",
"build-declaration": "tsc --allowJs --checkJs --declaration --emitDeclarationOnly --module nodenext --outDir dts --rootDir . --target es2015 lib/exports.mjs lib/exports-async.mjs lib/exports-promise.mjs lib/exports-sync.mjs lib/markdownlint.mjs lib/resolve-module.cjs && node scripts/index.mjs copy dts/lib/exports.d.mts lib/exports.d.mts && node scripts/index.mjs copy dts/lib/exports-async.d.mts lib/exports-async.d.mts && node scripts/index.mjs copy dts/lib/exports-promise.d.mts lib/exports-promise.d.mts && node scripts/index.mjs copy dts/lib/exports-sync.d.mts lib/exports-sync.d.mts && node scripts/index.mjs copy dts/lib/markdownlint.d.mts lib/markdownlint.d.mts && node scripts/index.mjs copy dts/lib/resolve-module.d.cts lib/resolve-module.d.cts && node scripts/index.mjs remove dts",
"build-demo": "node scripts/index.mjs copy node_modules/markdown-it/dist/markdown-it.min.js demo/markdown-it.min.js && cd demo && webpack --no-stats",
"build-docs": "node doc-build/build-rules.mjs",
"ci": "npm-run-all --continue-on-error --parallel build-demo lint serial-config-docs serial-declaration test-cover && git diff --exit-code",
@ -80,7 +80,8 @@
"micromark-extension-gfm-footnote": "2.1.0",
"micromark-extension-gfm-table": "2.1.1",
"micromark-extension-math": "3.1.0",
"micromark-util-types": "2.0.2"
"micromark-util-types": "2.0.2",
"string-width": "8.1.0"
},
"devDependencies": {
"@eslint/js": "9.39.1",

4
schema/.markdownlint.jsonc
View file

@ -340,8 +340,6 @@
// MD060/table-column-style : Table column style : https://github.com/DavidAnson/markdownlint/blob/v0.39.0/doc/md060.md
"MD060": {
// Table column style
"style": "any",
// RegExp for matching wide character(s)
"wide_character": "TBD"
"style": "any"
}
}

2
schema/.markdownlint.yaml
View file

@ -304,5 +304,3 @@ MD059:
MD060:
# Table column style
style: "any"
# RegExp for matching wide character(s)
wide_character: "TBD"

6
schema/build-config-schema.mjs
View file

@ -645,12 +645,6 @@ for (const rule of rules) {
],
"default": "any"
};
// @ts-ignore
subscheme.properties.wide_character = {
"description": "RegExp for matching wide character(s)",
"type": "string",
"default": "TBD"
};
break;
default:
break;

10
schema/markdownlint-config-schema-strict.json
View file

@ -4701,11 +4701,6 @@
"tight"
],
"default": "any"
},
"wide_character": {
"description": "RegExp for matching wide character(s)",
"type": "string",
"default": "TBD"
}
}
}
@ -4752,11 +4747,6 @@
"tight"
],
"default": "any"
},
"wide_character": {
"description": "RegExp for matching wide character(s)",
"type": "string",
"default": "TBD"
}
}
}

10
schema/markdownlint-config-schema.json
View file

@ -4701,11 +4701,6 @@
"tight"
],
"default": "any"
},
"wide_character": {
"description": "RegExp for matching wide character(s)",
"type": "string",
"default": "TBD"
}
}
}
@ -4752,11 +4747,6 @@
"tight"
],
"default": "any"
},
"wide_character": {
"description": "RegExp for matching wide character(s)",
"type": "string",
"default": "TBD"
}
}
}

2
test/markdownlint-test.mjs
View file

@ -1101,7 +1101,7 @@ test("readme", async(t) => {
});
test("validateJsonUsingConfigSchemaStrict", async(t) => {
t.plan(222);
t.plan(220);
// @ts-ignore
const ajv = new Ajv(ajvOptions);
const validateSchemaStrict = ajv.compile(configSchemaStrict);

236
test/snapshots/markdownlint-test-scenarios.mjs.md
View file

@ -72533,242 +72533,6 @@ Generated by [AVA](https://avajs.dev).
`,
}
## table-column-style-wide-characters-custom.md
> Snapshot 1
{
errors: [
{
errorContext: null,
errorDetail: 'Table pipe does not align with heading for style "aligned"',
errorRange: [
6,
1,
],
fixInfo: null,
lineNumber: 12,
ruleDescription: 'Table column style',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md060.md',
ruleNames: [
'MD060',
'table-column-style',
],
severity: 'error',
},
{
errorContext: null,
errorDetail: 'Table pipe does not align with heading for style "aligned"',
errorRange: [
11,
1,
],
fixInfo: null,
lineNumber: 12,
ruleDescription: 'Table column style',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md060.md',
ruleNames: [
'MD060',
'table-column-style',
],
severity: 'error',
},
{
errorContext: null,
errorDetail: 'Table pipe does not align with heading for style "aligned"',
errorRange: [
11,
1,
],
fixInfo: null,
lineNumber: 13,
ruleDescription: 'Table column style',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md060.md',
ruleNames: [
'MD060',
'table-column-style',
],
severity: 'error',
},
{
errorContext: null,
errorDetail: 'Table pipe does not align with heading for style "aligned"',
errorRange: [
6,
1,
],
fixInfo: null,
lineNumber: 14,
ruleDescription: 'Table column style',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md060.md',
ruleNames: [
'MD060',
'table-column-style',
],
severity: 'error',
},
{
errorContext: null,
errorDetail: 'Table pipe does not align with heading for style "aligned"',
errorRange: [
11,
1,
],
fixInfo: null,
lineNumber: 14,
ruleDescription: 'Table column style',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md060.md',
ruleNames: [
'MD060',
'table-column-style',
],
severity: 'error',
},
],
fixed: `# Table Column Style - Wide Characters (Custom)␊
␊
| NN | W |␊
| -- | -- |␊
| NN | NN |␊
| W | NN |␊
| NN | W |␊
| W | W |␊
| ✅N | NN |␊
| NN | ✅N |␊
| ✅N | ✅N |␊
| WW | NN |␊
| NN | WW |␊
| WW | WW |␊
␊
{MD060:-4} {MD060:-3} {MD060:-2}␊
␊
<!-- markdownlint-configure-file {␊
"table-column-style": {␊
"style": "aligned",␊
"wide_character": "[W]"␊
}␊
} -->␊
`,
}
## table-column-style-wide-characters-disable.md
> Snapshot 1
{
errors: [
{
errorContext: null,
errorDetail: 'Table pipe does not align with heading for style "aligned"',
errorRange: [
5,
1,
],
fixInfo: null,
lineNumber: 6,
ruleDescription: 'Table column style',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md060.md',
ruleNames: [
'MD060',
'table-column-style',
],
severity: 'error',
},
{
errorContext: null,
errorDetail: 'Table pipe does not align with heading for style "aligned"',
errorRange: [
10,
1,
],
fixInfo: null,
lineNumber: 6,
ruleDescription: 'Table column style',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md060.md',
ruleNames: [
'MD060',
'table-column-style',
],
severity: 'error',
},
{
errorContext: null,
errorDetail: 'Table pipe does not align with heading for style "aligned"',
errorRange: [
10,
1,
],
fixInfo: null,
lineNumber: 7,
ruleDescription: 'Table column style',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md060.md',
ruleNames: [
'MD060',
'table-column-style',
],
severity: 'error',
},
{
errorContext: null,
errorDetail: 'Table pipe does not align with heading for style "aligned"',
errorRange: [
5,
1,
],
fixInfo: null,
lineNumber: 8,
ruleDescription: 'Table column style',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md060.md',
ruleNames: [
'MD060',
'table-column-style',
],
severity: 'error',
},
{
errorContext: null,
errorDetail: 'Table pipe does not align with heading for style "aligned"',
errorRange: [
9,
1,
],
fixInfo: null,
lineNumber: 8,
ruleDescription: 'Table column style',
ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md060.md',
ruleNames: [
'MD060',
'table-column-style',
],
severity: 'error',
},
],
fixed: `# Table Column Style - Wide Characters (Disable)␊
␊
| NN | WW |␊
| -- | -- |␊
| NN | NN |␊
| W | NN |␊
| NN | W |␊
| W | W |␊
| ✅N | NN |␊
| NN | ✅N |␊
| ✅N | ✅N |␊
| WW | NN |␊
| NN | WW |␊
| WW | WW |␊
␊
{MD060:-10} {MD060:-9} {MD060:-8}␊
␊
<!-- markdownlint-configure-file {␊
"table-column-style": {␊
"style": "aligned",␊
"wide_character": "[]"␊
}␊
} -->␊
`,
}
## table-column-style-wide-characters.md
> Snapshot 1

BIN
test/snapshots/markdownlint-test-scenarios.mjs.snap
View file

Binary file not shown.

23
test/table-column-style-wide-characters-custom.md
View file

@ -1,23 +0,0 @@
# Table Column Style - Wide Characters (Custom)
| NN | W |
| -- | -- |
| NN | NN |
| W | NN |
| NN | W |
| W | W |
| ✅N | NN |
| NN | ✅N |
| ✅N | ✅N |
| WW | NN |
| NN | WW |
| WW | WW |
{MD060:-4} {MD060:-3} {MD060:-2}
<!-- markdownlint-configure-file {
"table-column-style": {
"style": "aligned",
"wide_character": "[W]"
}
} -->

23
test/table-column-style-wide-characters-disable.md
View file

@ -1,23 +0,0 @@
# Table Column Style - Wide Characters (Disable)
| NN | WW |
| -- | -- |
| NN | NN |
| W | NN |
| NN | W |
| W | W |
| ✅N | NN |
| NN | ✅N |
| ✅N | ✅N |
| WW | NN |
| NN | WW |
| WW | WW |
{MD060:-10} {MD060:-9} {MD060:-8}
<!-- markdownlint-configure-file {
"table-column-style": {
"style": "aligned",
"wide_character": "[]"
}
} -->