diff --git a/.circleci/config.yml b/.circleci/config.yml new file mode 100644 index 0000000..98ed34d --- /dev/null +++ b/.circleci/config.yml @@ -0,0 +1,29 @@ +version: 2 +jobs: + build: + working_directory: ~/impress.js + docker: + - image: circleci/node:current-browsers + steps: + - checkout + - run: + name: update-npm + command: 'sudo npm install -g npm@latest' + - restore_cache: + key: dependency-cache-{{ checksum "package.json" }} + - run: + name: install-npm + command: npm install + - save_cache: + key: dependency-cache-{{ checksum "package.json" }} + paths: + - ./node_modules + - run: + name: build + command: npm run build + - run: + name: lint + command: npm run lint + - run: + name: test + command: npm test diff --git a/.eslintrc.js b/.eslintrc.js new file mode 100644 index 0000000..9f3845e --- /dev/null +++ b/.eslintrc.js @@ -0,0 +1,296 @@ +module.exports = { + "env": { + "browser": true, + "es6": true + }, + "extends": "eslint:recommended", + "globals": { + "Atomics": "readonly", + "SharedArrayBuffer": "readonly" + }, + "parserOptions": { + "ecmaVersion": 2018 + }, + "rules": { + "accessor-pairs": "error", + "array-bracket-newline": "error", + "array-bracket-spacing": "error", + "array-callback-return": "error", + "array-element-newline": "error", + "arrow-body-style": "error", + "arrow-parens": "error", + "arrow-spacing": "error", + "block-scoped-var": "off", + "block-spacing": [ + "error", + "always" + ], + "brace-style": [ + "error", + "1tbs", + { + "allowSingleLine": true + } + ], + "callback-return": "error", + "camelcase": "error", + "capitalized-comments": "off", + "class-methods-use-this": "error", + "comma-dangle": "error", + "comma-spacing": [ + "error", + { + "after": true, + "before": false + } + ], + "comma-style": [ + "error", + "last" + ], + "complexity": "error", + "computed-property-spacing": [ + "error", + "always" + ], + "consistent-return": "error", + "consistent-this": "off", + "curly": "error", + "default-case": "error", + "dot-location": "error", + "dot-notation": "error", + "eol-last": "error", + "eqeqeq": "error", + "func-call-spacing": "error", + "func-name-matching": "error", + "func-names": "off", + "func-style": [ + "error", + "expression" + ], + "function-paren-newline": "error", + "generator-star-spacing": "error", + "global-require": "error", + "guard-for-in": "error", + "handle-callback-err": "error", + "id-blacklist": "error", + "id-length": "off", + "id-match": "error", + "implicit-arrow-linebreak": "error", + "indent": "error", + "indent-legacy": "error", + "init-declarations": "off", + "jsx-quotes": "error", + "key-spacing": "off", + "keyword-spacing": [ + "error", + { + "after": true, + "before": true + } + ], + "line-comment-position": "off", + "linebreak-style": [ + "error", + "unix" + ], + "lines-around-comment": "error", + "lines-around-directive": "off", + "lines-between-class-members": "error", + "max-classes-per-file": "error", + "max-depth": "error", + "max-len": "off", + "max-lines": "error", + "max-lines-per-function": "off", + "max-nested-callbacks": "error", + "max-params": "error", + "max-statements": "off", + "max-statements-per-line": "off", + "multiline-comment-style": [ + "error", + "separate-lines" + ], + "new-cap": "error", + "new-parens": "error", + "newline-after-var": "off", + "newline-before-return": "off", + "newline-per-chained-call": "error", + "no-alert": "error", + "no-array-constructor": "error", + "no-async-promise-executor": "error", + "no-await-in-loop": "error", + "no-bitwise": "error", + "no-buffer-constructor": "error", + "no-caller": "error", + "no-catch-shadow": "error", + "no-confusing-arrow": "error", + "no-continue": "error", + "no-div-regex": "error", + "no-duplicate-imports": "error", + "no-else-return": "error", + "no-empty-function": "error", + "no-eq-null": "error", + "no-eval": "error", + "no-extend-native": "error", + "no-extra-bind": "error", + "no-extra-label": "error", + "no-extra-parens": "off", + "no-floating-decimal": "error", + "no-implicit-coercion": "error", + "no-implicit-globals": "error", + "no-implied-eval": "error", + "no-inline-comments": "off", + "no-inner-declarations": [ + "error", + "functions" + ], + "no-invalid-this": "off", + "no-iterator": "error", + "no-label-var": "error", + "no-labels": "error", + "no-lone-blocks": "error", + "no-lonely-if": "error", + "no-loop-func": "error", + "no-magic-numbers": "off", + "no-misleading-character-class": "error", + "no-mixed-operators": "error", + "no-mixed-requires": "error", + "no-multi-assign": "error", + "no-multi-spaces": "off", + "no-multi-str": "error", + "no-multiple-empty-lines": "error", + "no-native-reassign": "error", + "no-negated-condition": "off", + "no-negated-in-lhs": "error", + "no-nested-ternary": "error", + "no-new": "error", + "no-new-func": "error", + "no-new-object": "error", + "no-new-require": "error", + "no-new-wrappers": "error", + "no-octal-escape": "error", + "no-param-reassign": "off", + "no-path-concat": "error", + "no-plusplus": "off", + "no-process-env": "error", + "no-process-exit": "error", + "no-proto": "error", + "no-prototype-builtins": "error", + "no-restricted-globals": "error", + "no-restricted-imports": "error", + "no-restricted-modules": "error", + "no-restricted-properties": "error", + "no-restricted-syntax": "error", + "no-return-assign": "error", + "no-return-await": "error", + "no-script-url": "error", + "no-self-compare": "error", + "no-sequences": "error", + "no-shadow": "off", + "no-shadow-restricted-names": "error", + "no-spaced-func": "error", + "no-sync": "error", + "no-tabs": "error", + "no-template-curly-in-string": "error", + "no-ternary": "off", + "no-throw-literal": "error", + "no-trailing-spaces": "error", + "no-undef-init": "error", + "no-undefined": "off", + "no-underscore-dangle": "error", + "no-unmodified-loop-condition": "error", + "no-unneeded-ternary": "error", + "no-unused-expressions": "error", + "no-use-before-define": "off", + "no-useless-call": "error", + "no-useless-catch": "error", + "no-useless-computed-key": "error", + "no-useless-concat": "error", + "no-useless-constructor": "error", + "no-useless-rename": "error", + "no-useless-return": "error", + "no-var": "off", + "no-void": "error", + "no-warning-comments": "error", + "no-whitespace-before-property": "error", + "no-with": "error", + "nonblock-statement-body-position": "error", + "object-curly-newline": "error", + "object-curly-spacing": [ + "error", + "always" + ], + "object-shorthand": "off", + "one-var": "off", + "one-var-declaration-per-line": "off", + "operator-assignment": "error", + "operator-linebreak": "error", + "padded-blocks": "off", + "padding-line-between-statements": "error", + "prefer-arrow-callback": "off", + "prefer-const": "error", + "prefer-destructuring": "off", + "prefer-numeric-literals": "error", + "prefer-object-spread": "error", + "prefer-promise-reject-errors": "error", + "prefer-reflect": "off", + "prefer-rest-params": "off", + "prefer-spread": "error", + "prefer-template": "off", + "quote-props": "off", + "quotes": [ + "error", + "double" + ], + "radix": "error", + "require-atomic-updates": "error", + "require-await": "error", + "require-jsdoc": "error", + "require-unicode-regexp": "off", + "rest-spread-spacing": "error", + "semi": "error", + "semi-spacing": [ + "error", + { + "after": true, + "before": false + } + ], + "semi-style": [ + "error", + "last" + ], + "sort-imports": "error", + "sort-keys": "off", + "sort-vars": "off", + "space-before-blocks": "error", + "space-before-function-paren": "off", + "space-in-parens": [ + "error", + "always" + ], + "space-infix-ops": "error", + "space-unary-ops": "error", + "spaced-comment": [ + "error", + "always" + ], + "strict": "error", + "switch-colon-spacing": "error", + "symbol-description": "error", + "template-curly-spacing": "error", + "template-tag-spacing": "error", + "unicode-bom": [ + "error", + "never" + ], + "valid-jsdoc": "error", + "vars-on-top": "off", + "wrap-regex": "error", + "yield-star-spacing": "error", + "yoda": [ + "error", + "never" + ] + } +}; diff --git a/.gitignore b/.gitignore index ea23cc4..c3ee490 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +/js/impress.min.js.map /js/impress.min.js /node_modules /npm-debug.log diff --git a/README.md b/README.md index 0b98dad..a7c83a0 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,17 @@ REPOSITORY STRUCTURE WANT TO CONTRIBUTE? --------------------- +### Requirements + +* >= node 7.6 +* npm + +### Setup + +```bash +npm install +``` + For developers, once you've made changes to the code, you should run these commands for testing: npm run build diff --git a/build.js b/build.js index 148d12d..33175cc 100644 --- a/build.js +++ b/build.js @@ -1,16 +1,13 @@ -var buildify = require('buildify'); +const fs = require('fs'); +var ls = require('ls'); +var path = require('path'); +var Terser = require("terser"); - -buildify() - .load('src/impress.js') - .perform(function(content){ - return "// This file was automatically generated from files in src/ directory.\n\n" + content; - }) - // Libraries from src/lib - .concat(['src/lib/gc.js']) - .concat(['src/lib/util.js']) - // Plugins from src/plugins - .concat(['src/plugins/autoplay/autoplay.js', +var files = ['src/impress.js']; +// Libraries from src/lib +files.push('src/lib/gc.js', 'src/lib/util.js') +// Plugins from src/plugins +files.push('src/plugins/autoplay/autoplay.js', 'src/plugins/blackout/blackout.js', 'src/plugins/extras/extras.js', 'src/plugins/form/form.js', @@ -30,22 +27,31 @@ buildify() 'src/plugins/stop/stop.js', 'src/plugins/substep/substep.js', 'src/plugins/touch/touch.js', - 'src/plugins/toolbar/toolbar.js']) - .save('js/impress.js'); -/* - * Disabled until uglify supports ES6: https://github.com/mishoo/UglifyJS2/issues/448 - .uglify() - .save('js/impress.min.js'); -*/ + 'src/plugins/toolbar/toolbar.js') +var output = files.map((f)=>{ + return fs.readFileSync(f).toString(); +}).join('\n') +fs.writeFileSync('js/impress.js', '// This file was automatically generated from files in src/ directory.\n\n' + output) + +// terser --compress --mangle --comments '/^!/' --source-map --output js/impress.min.js js/impress.js +var code = fs.readFileSync('js/impress.js').toString(); +var options = { + sourceMap: { + filename: 'js/impress.js', + url: 'js/impress.min.js.map' + }, + output: { + comments: /^!/ + } +}; +var result = Terser.minify({'js/impress.js': code}, options); +fs.writeFileSync('js/impress.min.js', result.code); +fs.writeFileSync('js/impress.min.js.map', result.map); /* Auto generate an index.html that lists all the directories under examples/ * This is useful for gh-pages, so you can link to http://impress.github.io/impress.js/examples */ -var ls = require('ls'); -var fs = require('fs'); -var path = require('path'); - var html_list = '