https://github.com/ahmedelwerdany/textlint-rule-no-empty-element

textlint rule that checks if any element in the markdown file is empty.
https://github.com/ahmedelwerdany/textlint-rule-no-empty-element

lint linter markdown

Last synced: 24 days ago
JSON representation

textlint rule that checks if any element in the markdown file is empty.

• Host: GitHub
• URL: https://github.com/ahmedelwerdany/textlint-rule-no-empty-element
• Owner: AhmedElwerdany
• Created: 2022-10-13T23:03:09.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-06-12T06:25:57.000Z (over 1 year ago)
• Last Synced: 2024-12-30T14:49:36.542Z (25 days ago)
• Topics: lint, linter, markdown
• Language: JavaScript
• Homepage:
• Size: 349 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# textlint-rule-no-empty-element

textlint rule that checks if any element in the markdown file is empty.

## Features

**OK** :green_heart:

```

# Header 1

## Header 2

### Header 3

- list item

```npm i textlint-rule-no-empty-element```

```

**NG** :negative_squared_cross_mark:

> Found Empty Header: `#`

> Found Empty Header: `##`

> Found Empty Header: `###` 

> Found Empty ListItem: `-`

> Found Empty Code: ` ``` ``` `

```

#

##

###

-

``` ```

```

## Install

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

    npm install textlint-rule-no-empty-element

## Usage

Via `.textlintrc`(Recommended)

```json

{

    "rules": {

        "no-empty-element": true

    }

}

```

Via CLI

```

textlint --rule textlint-rule-no-empty-element README.md

```

### Build

Builds source codes for publish to the `lib` folder.

You can write ES2015+ source codes in `src/` folder.

    npm run build

### Tests

Run test code in `test` folder.

Test textlint rule by [textlint-tester](https://github.com/textlint/textlint-tester).

    npm test

## License

ISC ©