Support for presets? about markdownlint

[DavidAnson]

Here's how I think you would do that today: Create desired rules in JSON file, put in npm package, publish, reference that package from each of your projects, "extend" it from each of those .markdownlint.json files (by relative path into node_modules). Would this work for you? If not, what's missing?

[DavidAnson]

If that works for you, I'll close this issue in a day or two.

[brendo]

Yes sorry, that solution is definitely workable, not pretty, but it'll work!

[DavidAnson]

How is it any uglier than what ESLint does? If you want, you can do the require/exports thing here as well. Only difference I see is the need for a require statement, but that seems trivial. Am I missing something?

[brendo]

ESLint supports specifying the package as simply a name, not a relative path, so you could do something like this:

{
  "extends": "markdownlint-config-example",
  "default": true
}

ESLint does a nice thing where example is also possible, as it'd automatically prepend eslint-config- when resolving the config.

If I understand the solution suggested, markdownlint would instead require:

{
  "extends": "./node_modules/markdownlint-config-example",
  "default": true
}

Very minor difference 😃

[DavidAnson]

Yes, that was my original suggestion!

If you're willing to do this in code, you can create a package that exports whatever config you want and then do something like:

var config = {
    extends: require("my-config-module")
}

Or even:

{
    extends: require("my-config-module").mySpecialConfig
}

All of which works today. :)

[brendo]

Excellent, I missed that, thanks for showing an example! Looks like I've got some configs to consolidate now 😄

[DavidAnson]

Great! If you feel like starting a library of configs that other people could reuse in their own projects, I'll link to it from the README. No pressure, just an idea I had. :)