From ba86d52847da671e536c27b62160a694dd213ceb Mon Sep 17 00:00:00 2001 From: silverwind Date: Thu, 16 May 2019 07:57:47 +0200 Subject: [PATCH] add make targets for js and css, add js linter (#6952) * add make targets for js,css, add javascript linter - add `make js`, deprecating `make javascripts` - add `make css`, deprecating `make generate-stylesheets` and `make stylesheets-check` - changed the unclean css check to only run on CI - add JS linting via eslint with basic configuration and fixed discovered issues - changed autoprefixer to use official `postcss-cli` avoiding the need to loop in the makefile - moved browserslist to package.json so other future tools can use it too. - update documentation for new make targets and added JS section * fix indentation * move functions used in html to 'exported' list * Run lessc binary without having to install anything to node_modules * use relative paths to node bin scripts, removing npx * Revert "use relative paths to node bin scripts, removing npx" This reverts commit 119b725525a8430b32ee7a6e6009b4ece544e39b. * fix lessc and postcss plugins * check for node_modules and use actual bin names --- doc/advanced/hacking-on-gitea.en-us.md | 34 +++++++++++++++----------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/doc/advanced/hacking-on-gitea.en-us.md b/doc/advanced/hacking-on-gitea.en-us.md index 1fabc1a1..48a45105 100644 --- a/doc/advanced/hacking-on-gitea.en-us.md +++ b/doc/advanced/hacking-on-gitea.en-us.md @@ -136,30 +136,36 @@ You should lint, vet and spell-check with: make vet lint misspell-check ``` -### Updating the stylesheets +### Updating CSS -To generate the stylsheets, you will need [Node.js](https://nodejs.org/) at version 8.0 or above. - -At present we use [less](http://lesscss.org/) and [postcss](https://postcss.org) to generate our stylesheets. Do -**not** edit the files in `public/css/` directly, as they are generated from -`lessc` from the files in `public/less/`. - -If you wish to work on the stylesheets, you will need to install `lessc` the -less compiler and `postcss`. The recommended way to do this is using `npm install`: +To generate the CSS, you will need [Node.js](https://nodejs.org/) 8.0 or greater and the build dependencies: ```bash -cd "$GOPATH/src/code.gitea.io/gitea" npm install ``` -You can then edit the less stylesheets and regenerate the stylesheets using: +At present we use [less](http://lesscss.org/) and [postcss](https://postcss.org) to generate our CSS. Do +**not** edit the files in `public/css` directly, as they are generated from `lessc` from the files in `public/less`. + +Edit files in `public/less`, run the linter, regenerate the CSS and commit all changed files: ```bash -make generate-stylesheets +make css ``` -You should commit both the changes to the css and the less files when making -PRs. +### Updating JS + +To run the JavaScript linter you will need [Node.js](https://nodejs.org/) 8.0 or greater and the build dependencies: + +```bash +npm install +``` + +Edit files in `public/js` and run the linter: + +```bash +make js +``` ### Updating the API