textlint-rule-preset-jtf-style

The recommended way to use the preset is to install it locally within your project. This keeps your environment clean.

1. Initialize your project and install textlint and the preset as dev dependencies:

npm init
npm install -D textlint textlint-rule-preset-jtf-style

2. Add the preset to your .textlintrc configuration file. Note that when using the preset name in the config, you must omit the textlint-rule- prefix and use preset-jtf-style.

3. Run textlint against your target files. If running via node_modules/.bin/textlint, it will automatically pick up the .textlintrc in the current directory.

{
    "rules": {
        "preset-jtf-style": true
    }
}

If the textlint script is defined in your package.json, you can lint the README.md file by running the following commands. This requires npm version 2.x or higher.

npm install
npm run textlint -- README.md

The quickest way to use the preset is to install textlint and the preset globally, then run textlint with the --preset flag. This will output the linting results for the specified file (e.g., README.md).

npm install -g textlint textlint-rule-preset-jtf-style
textlint --preset textlint-rule-preset-jtf-style README.md

Some rules within textlint-rule-preset-jtf-style support automatic fixing. You can use the --fix flag with the textlint command to automatically correct errors that can be determined mechanically.

Warning: This command modifies your files directly. Always ensure you have a backup or use version control before running it.

textlint --fix /path/to/target.md

Install the preset using npm to add it to your project dependencies.

npm install textlint-rule-preset-jtf-style

You can bypass npm scripts and run the textlint binary directly from your local node_modules directory to lint a specific markdown file.

npm install
./node_modules/.bin/textlint /path/to/target.md

Several dictionary-based rules (which use regular expressions) are disabled by default because they can easily conflict with other textlint rules. If you wish to use them, you must explicitly enable them in your .textlintrc configuration.

The following rules are disabled by default:

• 2.1.2.漢字
• 2.1.5.カタカナ
• 2.1.6.カタカナの長音
• 2.2.1.ひらがなと漢字の使い分け

{
    "rules": {
        "preset-jtf-style": {
            "2.1.2.漢字": true,
            "2.1.5.カタカナ": true,
            "2.1.6.カタカナの長音": true,
            "2.2.1.ひらがなと漢字の使い分け": true
        }
    }
}

By default, all rules included in textlint-rule-preset-jtf-style are enabled. To disable a specific rule, set its key to false within the preset-jtf-style object in your .textlintrc configuration.

Note that the rule keys follow the pattern jtf-style/<key_name>. You can find the exact key names in the src/index.js file of the package.

{
    "rules": {
        "preset-jtf-style": {
            "1.2.2.ピリオド(.)とカンマ(,)": false
        }
    }
}

The rule 3.3.かっこ類と隣接する文字の間のスペースの有無 (Spacing between parentheses and adjacent characters) allows you to control how half-width parentheses are handled via two options:

1. allowOutsideHalfParentheses: Controls whether half-width spaces outside parentheses are allowed.

   • Default: true (allowed)
   • Set to false to prohibit spaces outside parentheses.

2. requireOutsideHalfParentheses: Controls whether half-width spaces outside parentheses are required.

   • Default: false (not required)
   • Set to true to require spaces outside parentheses.

{
  "rules": {
    "preset-jtf-style": {
      "3.3.かっこ類と隣接する文字の間のスペースの有無": {
        "allowOutsideHalfParentheses": false
      }
    }
  }
}