{"id":40674,"library":"broccoli-lint-remark","title":"broccoli-lint-remark","description":"Broccoli plugin that wraps remark-lint for linting Markdown files in a Broccoli build pipeline. Version 1.1.0 is the current stable release, with low release cadence. It differs from direct remark-lint usage by integrating into Broccoli's asset pipeline, allowing lint results to be generated as test output (QUnit or Mocha) or custom test generators. It accepts remark and unified-engine options, and supports .remarkrc configuration files.","status":"active","version":"1.1.0","language":"javascript","source_language":"en","source_url":"git://github.com/BBVAEngineering/broccoli-lint-remark","tags":["javascript","remark","lint","broccoli","broccoli-remark","broccoli-lint","validate","markdown","md"],"install":[{"cmd":"npm install broccoli-lint-remark","lang":"bash","label":"npm"},{"cmd":"yarn add broccoli-lint-remark","lang":"bash","label":"yarn"},{"cmd":"pnpm add broccoli-lint-remark","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Core linting engine for Markdown files","package":"remark-lint","optional":false}],"imports":[{"note":"CommonJS default export; no ESM wrapper provided.","wrong":"import LintRemark from 'broccoli-lint-remark';","symbol":"LintRemark","correct":"const LintRemark = require('broccoli-lint-remark');"}],"quickstart":{"code":"const LintRemark = require('broccoli-lint-remark');\nconst funnel = require('broccoli-funnel');\n\nconst inputNode = funnel('src/markdown');\nconst linted = new LintRemark(inputNode, {\n  testGenerator: 'mocha',\n  remark: {\n    config: {\n      plugins: ['remark-lint']\n    }\n  }\n});\n\nmodule.exports = linted;","lang":"javascript","description":"Demonstrates usage of broccoli-lint-remark with a funnel source, mocha test generator, and remark-lint plugin configuration."},"warnings":[{"fix":"Always set `testGenerator` to a supported string or provide a custom function.","message":"The `testGenerator` option expects a string ('qunit' or 'mocha') or custom function. If omitted or set to null, no test output is generated, which may silently skip lint tests.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Set `persist: false` if you want to force re-lint on every build.","message":"The `persist` option defaults to true, but persisting state may cause stale lint results across restarts. Some users expect false for fresh builds.","severity":"deprecated","affected_versions":">=1.0.0"},{"fix":"Use `broccoli-lint-remark` only for generating test assertions, not for full tree linting.","message":"The plugin does not expose a `lintTree` hook like other Broccoli lint plugins; it only works as a filter node that produces test output or passes through files.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Ensure your custom testGenerator returns a valid test output string.","message":"If using a custom `testGenerator` function, it must return a string. Returning null or undefined will cause an error.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Refer to unified-engine documentation for allowed options. If an option is ignored, consider using a .remarkrc configuration file.","message":"The `remark` options object is passed directly to unified-engine; not all remark-lint options may be accepted if unified-engine rejects them.","severity":"gotcha","affected_versions":">=1.0.0"}],"env_vars":null,"search_vec":"'1.1.0':22 'accept':64 'allow':47 'asset':45 'broccoli':2,5,18,43,79,81,84 'broccoli-lint':83 'broccoli-lint-remark':1 'broccoli-remark':80 'build':19 'cadenc':31 'configur':74 'current':25 'custom':60 'differ':33 'direct':35 'engin':69 'file':15,75 'generat':52,62 'integr':41 'javascript':76 'lint':3,11,13,38,48,78,85 'low':29 'markdown':14,87 'md':88 'mocha':58 'option':70 'output':55 'pipelin':20,46 'plugin':6 'qunit':56 'releas':27,30 'remark':4,10,37,65,77,82 'remark-lint':9,36 'remarkrc':73 'result':49 'stabl':26 'support':72 'test':54,61 'unifi':68 'unified-engin':67 'usag':39 'valid':86 'version':21 'wrap':8","created_at":"2026-06-04T18:48:42.232522+00:00","updated_at":"2026-06-04T18:48:42.232522+00:00","problems":[{"fix":"Run `npm install --save-dev broccoli-lint-remark`","cause":"Package not installed locally.","error":"Error: Cannot find module 'broccoli-lint-remark'"},{"fix":"Change to `const LintRemark = require('broccoli-lint-remark');`","cause":"Using ES6 `import` instead of CommonJS `require`.","error":"TypeError: LintRemark is not a constructor"},{"fix":"Set `testGenerator: 'mocha'` (or 'qunit') or provide a custom function.","cause":"Invalid or missing testGenerator value.","error":"Error: The testGenerator option must be a string or function."}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/ember-cli/broccoli-lint-remark","github":"git://github.com/BBVAEngineering/broccoli-lint-remark","docs":null,"changelog":null,"pypi":null,"npm":"broccoli-lint-remark","openapi_spec":null,"status_page":null,"smithery":null,"categories":["testing"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-04","next_check":"2026-09-02","install_tag":null}}