https://github.com/kazupon/textlint-rule-no-period-on-paragraph-end

textlint rule for no period on paragraph end
https://github.com/kazupon/textlint-rule-no-period-on-paragraph-end

rule textlint textlintrule

Last synced: 2 months ago
JSON representation

textlint rule for no period on paragraph end

• Host: GitHub
• URL: https://github.com/kazupon/textlint-rule-no-period-on-paragraph-end
• Owner: kazupon
• License: mit
• Created: 2024-05-22T06:33:01.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-05-23T03:53:03.000Z (7 months ago)
• Last Synced: 2024-05-23T07:51:35.982Z (7 months ago)
• Topics: rule, textlint, textlintrule
• Language: TypeScript
• Homepage:
• Size: 380 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# textlint-rule-no-period-on-paragraph-end

textlint rule for no period on paragraph end

## 📖 Rule Details

This rule does not allow punctuation at the end of a paragraph. This use case is used, for example, when you want to express rhythm or lingering phrases in a sentence, such as in the Japanese word "体言止め"(ending a sentence with a noun).

### ❌ NG

```

This is simple paragraph.

This paragraph has multiple sentences. First sentence is here. And the last sentence is here.

これはシンプルな段落。

この段落には複数の文がある。これが最初、そしてこれが最後の文。

```

### ✅ OK

```

This is simple paragraph

This paragraph has multiple sentences. First sentence is here. And the last sentence is here

これはシンプルな段落

この段落には複数の文がある。これが最初、そしてこれが最後の文

```

## 💿 Installlation

Install with [npm](https://www.npmjs.com/):

```sh

npm install textlint-rule-no-period-on-paragraph-end

```

## 🚀 Usages

Via `.textlintrc.json`(Recommended):

```json

{

  "rules": {

    "no-period-on-paragraph-end": true

  }

}

```

Via CLI

```sh

textlint --rule no-period-on-paragraph-end README.md

```

## 🙌 Contributing guidelines

If you are interested in contributing to `textlint-rule-no-period-on-paragraph-end`, I highly recommend checking out [the contributing guidelines](/CONTRIBUTING.md) here. You'll find all the relevant information such as [how to make a PR](/CONTRIBUTING.md#pull-request-guidelines), [how to setup development](/CONTRIBUTING.md#development-setup)) etc., there.

## ©️ License

[MIT](http://opensource.org/licenses/MIT)