Skip to content

Commit

Permalink
chore: remove check documentation step
Browse files Browse the repository at this point in the history
  • Loading branch information
gajus committed May 23, 2024
1 parent 928a74f commit 308af7b
Show file tree
Hide file tree
Showing 4 changed files with 1 addition and 126 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,4 @@
!.github
!.gitignore
!.husky
!.README
!.releaserc
10 changes: 0 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Contributing

**`README.md` is a generated file. Do not edit it directly.** Edit the files inside `.README` instead.

## Pre-Commit Hook

When making a commit, the following Pre-Commit hooks run:
Expand Down Expand Up @@ -41,12 +39,4 @@ Run with `npm run lint`.
3. Create a file in `src/rules` named the `camelCase` version of your rule name
4. Add your rule file to `src/index.js`

### Adding Documentation

1. Create new file in `./.README/rules/[rule-name].md`.
* Use [./.README/rules/require-valid-file-annotation.md](./.README/rules/require-valid-file-annotation.md) as a template.
* Ensure that rule documentation document includes `<!-- assertions spaceAfterTypeColon -->` declaration.
1. Update [./.README/README.md](/.README/README.md) to include the new rule.
1. Run `npm run create-readme` to generate the new `README.md` (you must be on `master` branch for this command to work)

Note: Sections "The following patterns are considered problems:" and "The following patterns are not considered problems:" are **generated automatically** using the test cases.
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,7 @@
},
"scripts": {
"build": "rm -fr ./dist && tsc",
"check-documentation": "tsx ./src/bin/checkDocumentation",
"lint": "npm run check-documentation && eslint .",
"lint": "eslint .",
"test": "mocha --require tsx './tests/rules/*'"
},
"version": "0.0.0-development"
Expand Down
113 changes: 0 additions & 113 deletions src/bin/checkDocumentation.ts

This file was deleted.

0 comments on commit 308af7b

Please sign in to comment.