3.0.0

[azu]

3.0.0 Beta-0

This is beta release

You can try it:

npm install textlint-scripts@beta --save-dev

Summary

• Support Async Function Support async/await by default #23
• Inline static resources in building for Browser rollup bundle  #31
• Support TypeScript TypeScript Support #27

Breaking Changes 🔥

textlint-script build output compatible code for ES2015+.
It means that output code is not work on IE11.

Support Async Function ⭐️

Async/Await is supported by default.

Inline static resources by default ⭐️

textlint-script build inline Node fs calls with babel-plugin-static-fs for browser compatibility.

const fs = require("fs");
const path = require("path");
const text = fs.readFileSync(path.join(__dirname, "readme.md"), "utf-8");

will be

const fs = require("fs");
const path = require("path");
const text = "README CONTENT"

📝 You want to disable this behavior, set NO_INLINE env like NO_INLINE=1 textlint-scripts build.

Support TypeScript 🌟

textlint-script build and textlint-script test support TypeScript.
You can write textlint rule with TypeScript.

Migration Guide

• Migration Script: @textlint/migrate-textlint-scripts-typescript

If you want to write textlint rule with TypeScript, you can migrate it by following steps:

1. Install TypeScript env

npm install textlint-scripts@beta --save-dev
npm install --save-dev typescript ts-node @textlint/types @types/node

2. Rename .js to .ts
3. Fix TypeScript Error

@textlint/types provide types for textlint rule.

import { TextlintRuleModule, TextlintRuleReporter } from "@textlint/types";
export interface RuleOptions {
  foo: boolean;
}
const report: TextlintRuleReporter<RuleOptions> = function(context, options = {}) {
    const { Syntax, RuleError, report, getSource } = context;
    return {
        [Syntax.Str](node) {
            // ...
        }
    };
};
export default {
    linter: report,
    fixer: report
} as TextlintRuleModule;

4. npm test and npm run build.

Migration Scrips: @textlint/migrate-textlint-scripts-typescript

We also prepare migration script from textlint-script with JavaScript to textlint-script with TypeScript.

Migration script help you to do step 1.

# in you textlint rule project
npx @textlint/migrate-textlint-scripts-typescript

For more details, see @textlint/migrate-textlint-scripts-typescript.

Examples:

• refactor: migrate to TypeScrtipt textlint-ja/textlint-rule-no-doubled-joshi#24
• refactor(rule): Convert to TypeScript textlint-ja/textlint-rule-ja-no-abusage#11
• refactor(rule): migrate textlint-scripts textlint-ja/textlint-rule-no-nfd#1
• refactor(rule): prhのインライン化に対応 textlint-ja/textlint-rule-preset-JTF-style#69

[azu]

• @textlint/types should includes only type definition. refactor(utils): move implementation from types to utils textlint#611
  • textlint rule depended on @textlint/types as devDependencies
  • Release Release [email protected] textlint#617

[azu]

• Blocker fix: support import * as fs from "fs" Experience-Monks/babel-plugin-static-fs#17

[azu]

Browser suppport test tool
https://github.com/textlint/browser-run

[azu]

• Update https://github.com/textlint/textlint-rule-template-ts
• Update https://github.com/textlint/textlint-rule-template
• https://github.com/textlint/create-textlint-rule support --typescript

[azu]

We will release it at tommorow.

If you found an issue, please tell us.

Try to beta:

npm install -D [email protected]

[azu]

Release https://github.com/textlint/textlint-scripts/releases/tag/3.0.0 🎉