From 237986a7cabd6752dbefa5aaa6780820660c2e39 Mon Sep 17 00:00:00 2001 From: ylemkimon Date: Tue, 24 Jul 2018 01:46:15 +0900 Subject: [PATCH] Change build directory to `dist` and cleanup NPM scripts (#1500) * Move the build path to `dist` * mkdir dist if not exists * Remove build from .gitignore * Delete `dist/` before building and when cleaning --- .eslintignore | 1 - .flowconfig | 2 +- .gitignore | 3 ++- bower.json | 1 - lint_blacklist.txt | 1 - package.json | 10 ++++------ release.sh | 6 +++--- webpack.common.js | 2 +- 8 files changed, 11 insertions(+), 15 deletions(-) diff --git a/.eslintignore b/.eslintignore index f543aa19..a889c718 100644 --- a/.eslintignore +++ b/.eslintignore @@ -1,3 +1,2 @@ **/node_modules/* -build/* dist/* diff --git a/.flowconfig b/.flowconfig index 357cbcc4..e9e155eb 100644 --- a/.flowconfig +++ b/.flowconfig @@ -1,5 +1,5 @@ [ignore] -/build +/dist [include] diff --git a/.gitignore b/.gitignore index d556e39f..bfe173fb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ -build +katex.tar.gz +katex.zip node_modules npm-debug.log debug.log diff --git a/bower.json b/bower.json index 7a12d053..db6061ec 100644 --- a/bower.json +++ b/bower.json @@ -24,7 +24,6 @@ "/*.sh", "/package.json", "/Makefile", - "/build", "/test", "/src", "/contrib", diff --git a/lint_blacklist.txt b/lint_blacklist.txt index 688aebdb..90268b27 100644 --- a/lint_blacklist.txt +++ b/lint_blacklist.txt @@ -1,6 +1,5 @@ .git # Autogenerated code -build/** node_modules/** dist/** diff --git a/package.json b/package.json index 4292d070..2b9a94ae 100644 --- a/package.json +++ b/package.json @@ -70,17 +70,15 @@ "test:screenshots": "npm run test:screenshots:update -- --verify", "test:screenshots:update": "npm run prestart && dockers/Screenshotter/screenshotter.sh", "test:perf": "npm run prestart && NODE_ENV=test node test/perf-test.js", - "clean": "rm -rf build/* node_modules/", + "clean": "rm -rf dist/ node_modules/", "clean-install": "npm run clean && npm i", "prestart": "node check-node-version.js && check-dependencies && node src/unicodeMake.js > src/unicodeSymbols.js", "start": "webpack-dev-server --hot --config webpack.dev.js", "analyze": "webpack --config webpack.analyze.js", - "build": "npm run prestart && rimraf build/* && webpack", + "build": "npm run prestart && rimraf dist/ && mkdirp dist && cp README.md dist && webpack", "watch": "npm run build -- --watch", - "dist": "npm test && npm run build && npm run dist:copy && npm run dist:zip && npm run dist:dist", - "dist:copy": "cd build && mkdirp katex && cp -r katex.js katex.min.js katex.css katex.min.css contrib fonts ../README.md katex", - "dist:zip": "cd build && tar czf katex.tar.gz katex/ && zip -rq katex.zip katex/", - "dist:dist": "rimraf dist/ && cp -r build/katex/ dist/" + "dist": "npm test && npm run build && npm run dist:zip", + "dist:zip": "cd dist && tar czf ../katex.tar.gz * && zip -rq ../katex.zip *" }, "dependencies": { "nomnom": "^1.8.1" diff --git a/release.sh b/release.sh index b26f3c36..cd63602f 100755 --- a/release.sh +++ b/release.sh @@ -109,7 +109,7 @@ sed -i.bak -E 's|"version": "[^"]+",|"version": "'$VERSION'",|' package.json rm -f package.json.bak # Build generated files and add them to the repository (for bower) -git clean -fdx build dist +git clean -fdx dist npm run dist sed -i.bak -E '/^\/dist\/$/d' .gitignore rm -f .gitignore.bak @@ -145,7 +145,7 @@ if [ ! -z "$NEXT_VERSION" ]; then git commit -n -m "Bump $BRANCH to v$NEXT_VERSION-pre" git push origin "$BRANCH" - # Go back to the tag which has build/katex.tar.gz and build/katex.zip + # Go back to the tag which has katex.tar.gz and katex.zip git checkout "v$VERSION" fi @@ -153,7 +153,7 @@ echo "" echo "The automatic parts are done!" echo "Now all that's left is to create the release on github." echo "Visit https://github.com/Khan/KaTeX/releases/new?tag=v$VERSION to edit the release notes" -echo "Don't forget to upload build/katex.tar.gz and build/katex.zip to the release!" +echo "Don't forget to upload katex.tar.gz and katex.zip to the release!" if [[ ${DRY_RUN} ]]; then echo "" diff --git a/webpack.common.js b/webpack.common.js index 06f7020a..c5ba29ff 100644 --- a/webpack.common.js +++ b/webpack.common.js @@ -63,7 +63,7 @@ function createConfig(target /*: Target */, dev /*: boolean */, // Enable output modules to be used in browser or Node. // See: https://github.com/webpack/webpack/issues/6522 globalObject: "(typeof self !== 'undefined' ? self : this)", - path: path.resolve(__dirname, 'build'), + path: path.resolve(__dirname, 'dist'), publicPath: dev ? '/' : '', }, module: {