build(linting): add Husky hooks, Markdown linting, lint all MD files
This commit is contained in:
parent
c9aa7dcc5f
commit
2279bbef38
9 changed files with 6584 additions and 427 deletions
77
README.md
77
README.md
|
|
@ -1,19 +1,23 @@
|
|||
# footnotes
|
||||
|
||||
<!-- markdownlint-disable MD013 -->
|
||||
    
|
||||
|
||||
    
|
||||
|
||||
[](https://www.gnu.org/licenses/gpl-3.0)  [](https://github.com/markcheret/footnotes/actions/workflows/ossar-analysis.yml) [](https://github.com/markcheret/footnotes/actions/workflows/php.yml)
|
||||
|
||||
[](http://commitizen.github.io/cz-cli/)
|
||||
<!-- markdownlint-enable MD013 -->
|
||||
|
||||
|
||||
|
||||
**footnotes** aims to be the all-in-one solution for displaying an
|
||||
automatically-generated list of references on your Page or Post. The Plugin
|
||||
ships with a set of defaults while also empowering you to control how your
|
||||
**footnotes** aims to be the all-in-one solution for displaying an
|
||||
automatically-generated list of references on your Page or Post. The Plugin
|
||||
ships with a set of defaults while also empowering you to control how your
|
||||
footnotes will be displayed.
|
||||
|
||||
**footnotes** gives you the ability to display well-formatted footnotes on your
|
||||
**footnotes** gives you the ability to display well-formatted footnotes on your
|
||||
WordPress Pages and Posts — those footnotes we know from offline publishing.
|
||||
|
||||
Featured on [wpmudev][wpmudev] — cheers for the review, folks!
|
||||
|
|
@ -34,25 +38,25 @@ Featured on [wpmudev][wpmudev] — cheers for the review, folks!
|
|||
|
||||
This Plugin provides:
|
||||
|
||||
- fully customizable footnote start and end shortcodes;
|
||||
- stylable tooltips supporting hyperlinks and dedicated text;
|
||||
- a responsive 'reference container', with customisable positioning;
|
||||
- a wide choice of different numbering styles;
|
||||
- a freely-configurable and optional backlink symbol;
|
||||
- footnote appearance customisation via dashboard settings and custom CSS style
|
||||
* fully customizable footnote start and end shortcodes;
|
||||
* stylable tooltips supporting hyperlinks and dedicated text;
|
||||
* a responsive 'reference container', with customisable positioning;
|
||||
* a wide choice of different numbering styles;
|
||||
* a freely-configurable and optional backlink symbol;
|
||||
* footnote appearance customisation via dashboard settings and custom CSS style
|
||||
rules; and
|
||||
- editor buttons for easily adding shortcode tags.
|
||||
* editor buttons for easily adding shortcode tags.
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. Read the [contributing guidelines][contributing];
|
||||
1. clone this repository (`git clone git@github.com:markcheret/footnotes.git`):
|
||||
- we recommend that you use [VVV][vvv] for your local testing environment.
|
||||
* we recommend that you use [VVV][vvv] for your local testing environment.
|
||||
1. install [Composer][composer] and [NPM][npm]; and
|
||||
1. install all dependencies (`composer install`):
|
||||
- you will have to install `php-mbstring` manually if you do not already
|
||||
* you will have to install `php-mbstring` manually if you do not already
|
||||
have it.
|
||||
|
||||
|
||||
## Deploying
|
||||
|
||||
Automated release deployments will be introduced soon.
|
||||
|
|
@ -61,14 +65,14 @@ Automated release deployments will be introduced soon.
|
|||
|
||||
1. Run `_tools/build-stylesheets.sh -c` to concatenate stylesheets;
|
||||
1. manually minify the output files in `css/tmp/`, saving them as `.min.css` files:
|
||||
- the intention is to replace this with automated minification, meaning that
|
||||
* the intention is to replace this with automated minification, meaning that
|
||||
all of these steps can be rolled into a single `build` command.
|
||||
1. run `_tools/build-stylesheets.sh -d` to deploy the minified files to `dist/`:
|
||||
- **this will delete any existing `dist/` folder!**
|
||||
* **this will delete any existing `dist/` folder!**
|
||||
1. run `composer run build` to move over the remaining files to `dist/`:
|
||||
- currently, the files to include in a distribution are hard-coded in
|
||||
* currently, the files to include in a distribution are hard-coded in
|
||||
`_tools/build.sh`; but
|
||||
- the intention is to replace this with a proper parsing of the `.distignore`
|
||||
* the intention is to replace this with a proper parsing of the `.distignore`
|
||||
file
|
||||
|
||||
### Releasing
|
||||
|
|
@ -76,43 +80,43 @@ Automated release deployments will be introduced soon.
|
|||
1. Ensure that you have configured your Git config. with SVN credentials;
|
||||
1. run the above [build](#building) commands; and
|
||||
1. run `composer run release` and follow the prompts.
|
||||
|
||||
|
||||
## Testing
|
||||
|
||||
Automated testing will be introduced soon.
|
||||
|
||||
## Code Formatting
|
||||
|
||||
This repo. uses pre-commit code formatting and linting on all staged files.
|
||||
This repo. uses pre-commit code formatting and linting on all staged files.
|
||||
This ensures that only style-conformant code can be committed.
|
||||
|
||||
The individual commands can also be called manually:
|
||||
|
||||
- Run `composer run format` to run all format commands.
|
||||
- Run `composer run format:fix` to attempt to automatically fix all formatter warnings
|
||||
* Run `composer run format` to run all format commands.
|
||||
* Run `composer run format:fix` to attempt to automatically fix all formatter warnings
|
||||
and errors.
|
||||
|
||||
- Run `composer run lint` to run all linting commands.
|
||||
- Run `composer run lint:fix` to attempt to automatically fix all linter warnings and
|
||||
errors.
|
||||
* Run `composer run lint` to run all linting commands.
|
||||
* Run `composer run lint:fix` to attempt to automatically fix all linter warnings
|
||||
and errors.
|
||||
|
||||
### PHP Code
|
||||
|
||||
PHP code must follow the [WordPress PHP Coding Standards][wpcs-php].
|
||||
|
||||
1. Run `composer run lint:php` to lint all JS/TS files with [PHP CodeSniffer][phpcs]
|
||||
1. Run `composer run lint:php:fix` to attempt to automatically fix warnings and
|
||||
1. Run `composer run lint:php:fix` to attempt to automatically fix warnings and
|
||||
errors with the PHP Code Beautifier and Formatter.
|
||||
|
||||
### JavaScript Code
|
||||
|
||||
JavaScript code must follow the [WordPress JavaScript Coding Standards][wpcs-js].
|
||||
|
||||
- Run `composer run format:js` to format all JS files with [Prettier][prettier].
|
||||
- Run `composer run format:js:fix` to attempt to automatically fix warnings and errors.
|
||||
* Run `composer run format:js` to format all JS files with [Prettier][prettier].
|
||||
* Run `composer run format:js:fix` to attempt to automatically fix warnings and errors.
|
||||
|
||||
- Run `composer run lint:js` to lint all JS files with [ESLint][eslint].
|
||||
- Run `composer run lint:js:fix` to attempt to automatically fix warnings and errors.
|
||||
* Run `composer run lint:js` to lint all JS files with [ESLint][eslint].
|
||||
* Run `composer run lint:js:fix` to attempt to automatically fix warnings and errors.
|
||||
|
||||
Prettier configuration settings are found in `.prettierrc`.
|
||||
|
||||
|
|
@ -123,32 +127,33 @@ found in `.eslintignore`.
|
|||
|
||||
JavaScript code must follow the [WordPress CSS Coding Standards][wpcs-css].
|
||||
|
||||
- Run `composer run lint:css` to format all CSS files with [stylelint][stylelint].
|
||||
- Run `npcomposerm run lint:css:fix` to attempt to automatically fix warnings and errors.
|
||||
* Run `composer run lint:css` to format all CSS files with [stylelint][stylelint].
|
||||
* Run `npcomposerm run lint:css:fix` to attempt to automatically fix warnings and
|
||||
errors.
|
||||
|
||||
stylelint configuration settings are found in `.stylelint.json`.
|
||||
|
||||
## Documentation
|
||||
|
||||
Run `composer run docs` to automatically generate HTML documentation with
|
||||
Run `composer run docs` to automatically generate HTML documentation with
|
||||
[phpDocumentor][phpdocumentor].
|
||||
|
||||
View the current docs [here][footnotes-docs].
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
Huge thanks to every **footnotes user**, contributor, bug reporter, feature
|
||||
Huge thanks to every **footnotes user**, contributor, bug reporter, feature
|
||||
requester and fan!
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the [GNU GPL v3][gpl-v3].
|
||||
|
||||
## Contact Information
|
||||
## Contact Information
|
||||
|
||||
| Name | Link(s) |
|
||||
|---------------|-----------------------|
|
||||
|Mark Cheret | [Email][mcheret] |
|
||||
|Mark Cheret | [Email][mcheret] |
|
||||
|
||||
[wpmudev]: http://premium.wpmudev.org/blog/12-surprisingly-useful-wordpress-plugins-you-dont-know-about/
|
||||
[php]: https://www.php.net/
|
||||
|
|
|
|||
Reference in a new issue