Skip to content

Update config files to use plain JS instead of JSON #149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 5 additions & 10 deletions index.js
Original file line number Diff line number Diff line change
@@ -1,18 +1,13 @@
import { readFile } from "fs/promises";
import _ from "lodash-es";
import { githubMarkdownLint } from "./src/rules/index.js";

const offByDefault = ["no-empty-alt-text"];
import accessibilityRules from "./style/accessibility.js";
import baseRules from "./style/base.js";

export async function init(consumerConfig) {
// left overwrites right
const accessibilityRules = JSON.parse(
await readFile(new URL("./style/accessibility.json", import.meta.url)),
);
const offByDefault = ["no-empty-alt-text"];

const base = JSON.parse(
await readFile(new URL("./style/base.json", import.meta.url)),
);
export function init(consumerConfig) {
const base = { ...baseRules };

for (const rule of githubMarkdownLint) {
const ruleName = rule.names[1];
Expand Down
14 changes: 14 additions & 0 deletions style/accessibility.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
export default {
"no-alt-text": true,
"no-default-alt-text": true,
"no-duplicate-heading": true,
"no-emphasis-as-heading": true,
"no-generic-link-text": true,
"heading-increment": true,
"no-space-in-links": false,
"ol-prefix": "ordered",
"single-h1": true,
"ul-style": {
style: "asterisk",
},
};
14 changes: 0 additions & 14 deletions style/accessibility.json

This file was deleted.

7 changes: 7 additions & 0 deletions style/base.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export default {
default: true,
"no-inline-html": false,
"no-bare-urls": false,
"no-blanks-blockquote": false,
"fenced-code-language": true,
};
7 changes: 0 additions & 7 deletions style/base.json

This file was deleted.

5 changes: 1 addition & 4 deletions test/accessibility-rules.test.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
import { readFile } from "fs/promises";
import { lint } from "markdownlint/async";
import githubMarkdownLint from "../index.js";
import accessibilityRules from "../style/accessibility.js";

const exampleFileName = "./test/example.md";

describe("when A11y rules applied", () => {
test("fails expected rules", async () => {
const accessibilityRules = JSON.parse(
await readFile(new URL("../style/accessibility.json", import.meta.url)),
);
const options = {
config: {
default: false,
Expand Down