OpenINF/.github

[bug] ` .remarkrc.mjs` does not spark joy (e.g., `remark-preset-*` deps)

Closed this issue · 8 comments

image

This has been an ongoing issue, and we (@OpenINF/wg-a-team) have started working on this in other channels and repos (e.g., our yet-to-be launched @OpenINF/standards repo).

I want to get this taken care of here and now while taking those learnings back to that project.

Presets of remark-lint rules can be folded into a single @OpenINF dependency, but prior to doing that, let's see about whether we have duplication btwx all of our currently-depended-on remark-preset-* deps).

.github/.remarkrc.mjs

Lines 82 to 83 in bdf59bd

[await import('remark-lint-blockquote-indentation'), 2],
[

remark-lint-blockquote-indentation

… is contained in https://www.npmjs.com/package/remark-preset-lint-markdown-style-guide and properly configured.

[await import('remark-lint-code-block-style'), 'fenced'],

remark-lint-code-block-style

… is contained in https://www.npmjs.com/package/remark-preset-lint-markdown-style-guide and properly configured.

[await import('remark-lint-fenced-code-flag'), { flags: infoStrings }],

remark-lint-fenced-code-flag

… is contained in https://www.npmjs.com/package/remark-preset-lint-markdown-style-guide, but is improperly configured.

await import('remark-lint-definition-spacing'),

remark-lint-definition-spacing

… is contained in https://www.npmjs.com/package/remark-preset-lint-markdown-style-guide and properly configured.

.github/.remarkrc.mjs

Lines 95 to 100 in bdf59bd

// Remark Lint Style Guide preset and overrides.
['remark-preset-lint-markdown-style-guide'],
['remark-lint-no-file-name-mixed-case', false],
['remark-lint-no-heading-punctuation', ':.,;'],
['remark-lint-no-file-name-irregular-characters', false],
['remark-lint-first-heading-level', 2],

remark-lint-no-file-name-irregular-characters

… is [indeed] contained in https://www.npmjs.com/package/remark-preset-lint-markdown-style-guide, however, perhaps improperly configured.

We were not done quite yet; lingering deps likely remain & still not sparking joy over here!!

Well, we will come back to this since i want to tackle it safely (proper isolation, containerization); moving progress here preferably doing OpenINF/docker-fisher#16 first.