-
Notifications
You must be signed in to change notification settings - Fork 23.3k
feat: add README template generator with Node.js workflow and configuration examples #155
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 15 commits
5908325
edd3504
1f79f52
fc88a2f
95b65aa
956317b
2a7c6cf
6d70f1c
e813e9b
e7e4883
40ba97e
5a0686c
3fc7219
e9ef2ba
fa65554
e90e79a
37ebfb8
68f765e
b91412c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Markdown Linting #152 |
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You were missing a .gitignore and I ran some tests etc. with code tools locally, so I made one to just make it simple to not need to clean the directory tree all the time |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # Node.js | ||
| node_modules/ | ||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* | ||
| package-lock.json | ||
|
|
||
| # Python virtual environment | ||
| .venv/ | ||
| venv/ | ||
|
|
||
| # Generated files | ||
| *.tmp | ||
|
|
||
| # OS generated files | ||
| .DS_Store | ||
| .DS_Store? | ||
| ._* | ||
| .Spotlight-V100 | ||
| .Trashes | ||
| ehthumbs.db | ||
| Thumbs.db | ||
|
|
||
| # IDE files | ||
| .vscode/ | ||
| .idea/ | ||
| *.swp | ||
| *.swo | ||
|
|
||
| # Temporary files | ||
| *.tmp | ||
| *.temp |
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not sure what these were... should they be part of the repo? |
This file was deleted.
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not sure what these were... should they be part of the repo? |
This file was deleted.
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not sure what these were... should they be part of the repo? |
This file was deleted.
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not sure what these were... should they be part of the repo? |
This file was deleted.
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not sure what these were... should they be part of the repo? |
This file was deleted.
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Markdown Linting #152 |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| { | ||
| "MD013": { | ||
| "line_length": 80, | ||
| "code_blocks": false, | ||
| "tables": false, | ||
| "headings": false | ||
| }, | ||
| "MD033": { | ||
| "allowed_elements": [ | ||
| "a", | ||
| "div", | ||
| "img", | ||
| "h1", | ||
| "h2", | ||
| "h3", | ||
| "h4", | ||
| "h5", | ||
| "h6", | ||
| "p", | ||
| "br", | ||
| "strong", | ||
| "em", | ||
| "details", | ||
| "summary", | ||
| "ol", | ||
| "ul", | ||
| "li" | ||
| ] | ||
| }, | ||
| "MD041": false, | ||
| "MD034": false | ||
| } |
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. New for this PR - auto generates the readme everytime there is an update to the config.json or the template file. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| fail_fast: false | ||
| minimum_pre_commit_version: "2.6.0" | ||
| repos: | ||
| # README Generator validation | ||
| - repo: https://github.com/actuarysailor/pre-commit-readme-generator | ||
| rev: v1.0.0 | ||
| hooks: | ||
| - id: readme-generator-update | ||
| args: [configs/example.json, README.md, BLANK_README.md] | ||
|
|
||
| # Standard file checks | ||
| - repo: https://github.com/pre-commit/pre-commit-hooks | ||
| rev: v6.0.0 | ||
| hooks: | ||
| - id: trailing-whitespace | ||
| - id: end-of-file-fixer | ||
| - id: check-merge-conflict | ||
| - id: check-yaml | ||
| - id: check-json | ||
| - id: check-added-large-files | ||
| - id: check-case-conflict | ||
| - id: mixed-line-ending | ||
| args: ['--fix=lf'] | ||
|
|
||
| # Markdown linting | ||
| - repo: https://github.com/igorshubovych/markdownlint-cli | ||
| rev: v0.45.0 | ||
| hooks: | ||
| - id: markdownlint | ||
| args: ['--fix'] | ||
| exclude: '^CHANGELOG\.md$' | ||
|
|
||
| # JSON formatting | ||
| - repo: https://github.com/pre-commit/mirrors-prettier | ||
| rev: v3.0.3 | ||
| hooks: | ||
| - id: prettier | ||
| types: [json] | ||
| args: ['--write'] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Markdown Linting #152