@textlint/config-inliner
TypeScript icon, indicating that this package has built-in type declarations

0.17.0 • Public • Published

@textlint/config-inliner

Inlining config for supporting browser.

Some rules use fs, so fs module does not work in a browser. Instead of using fs, inlining the content before compiling by @textlint/script-compiler.

textlint-scripts build inlining fs usage by default.

@textlint/config-inliner's target is .textlintrc configration file.

  • [ ] TODO: we need to defined common rule for inlining.

Supported Rules

Install

Install with npm:

npm install @textlint/config-inliner

Usage

import { loadConfig } from "@textlint/config-loader";
import { inlineConfig } from "@textlint/config-inliner";
const configResult = await loadConfig();
const inlinedConfig = await inlineConfig({
    cwd: process.cwd(),
    configFilePath: configResult.configFilePath,
    config: configResult.config
});

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu

Readme

Keywords

Package Sidebar

Install

npm i @textlint/config-inliner

Weekly Downloads

427

Version

0.17.0

License

MIT

Unpacked Size

29.7 kB

Total Files

17

Last publish

Collaborators

  • textlint-user
  • azu
  • 0x6b