From 7e5977abe49aa084cca72ee5b6ac73eea2dcd60c Mon Sep 17 00:00:00 2001 From: Bauke Date: Tue, 19 Feb 2019 15:58:27 +0100 Subject: [PATCH] chore: adjust code style --- .eslintrc.json | 7 ++- .stylelintignore | 1 + bump.js | 44 +++++++++---------- gulpfile.js | 108 +++++++++++++++++++++++------------------------ 4 files changed, 82 insertions(+), 78 deletions(-) create mode 100644 .stylelintignore diff --git a/.eslintrc.json b/.eslintrc.json index 7de0f0f..d736fa7 100755 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -7,18 +7,21 @@ }, "extends": "eslint:recommended", "rules": { + "comma-dangle": [ + "error", + "always-multiline" + ], "indent": [ "error", 2 ], - "no-console": "off", "quotes": [ "error", "single" ], "semi": [ "error", - "never" + "always" ] } } diff --git a/.stylelintignore b/.stylelintignore new file mode 100644 index 0000000..b8fe34b --- /dev/null +++ b/.stylelintignore @@ -0,0 +1 @@ +css/** diff --git a/bump.js b/bump.js index 0c70b87..fa23884 100644 --- a/bump.js +++ b/bump.js @@ -1,7 +1,7 @@ // Bumps a specified style's version -const fs = require('fs') -const path = require('path') +const fs = require('fs'); +const path = require('path'); /** * @function bump @@ -11,43 +11,43 @@ const path = require('path') function bump(jsonPath, incrementType) { if (!fs.existsSync(jsonPath)) - throw Error(`File ${jsonPath} does not exist.`) + throw Error(`File ${jsonPath} does not exist.`); if (path.extname(jsonPath) !== '.json') - throw Error(`File ${jsonPath} does not end in "json".`) + throw Error(`File ${jsonPath} does not end in "json".`); if (typeof incrementType === 'undefined') - throw Error('No valid increment type was included. Valid: "major", "minor" or "patch".') + throw Error('No valid increment type was included. Valid: "major", "minor" or "patch".'); if (incrementType !== 'major' && incrementType !== 'minor' && incrementType !== 'patch') - throw Error(`Increment type ${incrementType} does not equal "major", "minor" or "patch".`) + throw Error(`Increment type ${incrementType} does not equal "major", "minor" or "patch".`); - const jsonFile = require(jsonPath) + const jsonFile = require(jsonPath); if (typeof jsonFile.options.version === 'undefined') - throw Error(`${jsonFile} does not include a "version" property.`) + throw Error(`${jsonFile} does not include a "version" property.`); const incrementTypes = { 'major': 0, 'minor': 1, - 'patch': 2 - } + 'patch': 2, + }; - const oldVersion = jsonFile.options.version.split('.') - let bumped = parseInt(oldVersion[incrementTypes[incrementType]]) + 1 - let newVersion + const oldVersion = jsonFile.options.version.split('.'); + let bumped = parseInt(oldVersion[incrementTypes[incrementType]]) + 1; + let newVersion; switch (incrementType) { case 'major': - newVersion = `${bumped}.0.0` - break + newVersion = `${bumped}.0.0`; + break; case 'minor': - newVersion = `${oldVersion[0]}.${bumped}.0` - break + newVersion = `${oldVersion[0]}.${bumped}.0`; + break; case 'patch': - newVersion = `${oldVersion[0]}.${oldVersion[1]}.${bumped}` - break + newVersion = `${oldVersion[0]}.${oldVersion[1]}.${bumped}`; + break; } - jsonFile.options.version = newVersion + jsonFile.options.version = newVersion; - fs.writeFileSync(jsonPath, JSON.stringify(jsonFile, null, 2)) + fs.writeFileSync(jsonPath, JSON.stringify(jsonFile, null, 2)); } -exports.bump = bump +exports.bump = bump; diff --git a/gulpfile.js b/gulpfile.js index 18c5736..364f3d9 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -1,113 +1,113 @@ -const beautify = require('gulp-cssbeautify') -const gulp = require('gulp') -const eslint = require('gulp-eslint') -const fs = require('fs') -const stylelint = require('gulp-stylelint') -const sass = require('gulp-sass') +const beautify = require('gulp-cssbeautify'); +const gulp = require('gulp'); +const eslint = require('gulp-eslint'); +const fs = require('fs'); +const stylelint = require('gulp-stylelint'); +const sass = require('gulp-sass'); gulp.task('lint:js', () => { return gulp.src(['**/*.js','!node_modules/**']) .pipe(eslint()) - .pipe(eslint.format()) -}) + .pipe(eslint.format()); +}); gulp.task('lint:sass', () => { const options = { - reporters: [{formatter: 'string', console: true}] - } + reporters: [{formatter: 'string', console: true}], + }; return gulp.src('sass/**/*.s*') - .pipe(stylelint(options)) -}) + .pipe(stylelint(options)); +}); gulp.task('build:dev', () => { const options = { - outputStyle: 'compressed' - } + outputStyle: 'compressed', + }; const bOptions = { indent: ' ', - autosemicolon: true - } + autosemicolon: true, + }; return gulp.src('sass/**/*.s*') .pipe(sass(options).on('error', sass.logError)) .pipe(beautify(bOptions)) - .pipe(gulp.dest('temp')) -}) + .pipe(gulp.dest('temp')); +}); gulp.task('build:prod', () => { const options = { - outputStyle: 'compressed' - } + outputStyle: 'compressed', + }; const bOptions = { indent: ' ', - autosemicolon: true - } + autosemicolon: true, + }; return gulp.src('sass/**/*.s*') .pipe(sass(options).on('error', sass.logError)) .pipe(beautify(bOptions)) - .pipe(gulp.dest('css')) -}) + .pipe(gulp.dest('css')); +}); gulp.task('generate', ['lint:js', 'lint:sass', 'build:dev', 'build:prod'], () => { // Generates all *.user.css styles. - const { bump } = require('./bump.js') - const klawSync = require('klaw-sync') - const path = require('path') - const userCss = require('usercss-creator') + const { bump } = require('./bump.js'); + const klawSync = require('klaw-sync'); + const path = require('path'); + const userCss = require('usercss-creator'); // Define constants - const stylesDirectory = path.join(__dirname, 'sass') - const cssDirectory = path.join(__dirname, 'temp') + const stylesDirectory = path.join(__dirname, 'sass'); + const cssDirectory = path.join(__dirname, 'temp'); // Walk recursively through styles directory - let files = klawSync(stylesDirectory, {nodir: true}) + let files = klawSync(stylesDirectory, {nodir: true}); // Filter out any files that aren't .json files - files = files.filter(file => path.extname(file.path) === '.json') + files = files.filter(file => path.extname(file.path) === '.json'); - let style - let incrementType + let style; + let incrementType; for (const arg of process.argv) { if (arg.includes('--bump')) { - style = arg.substring('--bump='.length, arg.length) + style = arg.substring('--bump='.length, arg.length); } switch (arg) { case '--major': - incrementType = 'major' - break + incrementType = 'major'; + break; case '--minor': - incrementType = 'minor' - break + incrementType = 'minor'; + break; case '--patch': - incrementType = 'patch' - break + incrementType = 'patch'; + break; } } // Iterate through all .json files for (const file of files) { // Requiring the .json file as the descriptor of the style - const descriptor = require(file.path) + const descriptor = require(file.path); // If --bump=all then bump every style if (style === 'all') { - bump(file.path, incrementType) + bump(file.path, incrementType); } // Test if the style we want to bump is the one currently generating else if (style === descriptor.folder) { // Bump the style's .json with the increment type - bump(file.path, incrementType) + bump(file.path, incrementType); } // Create the css path and generate the .user.css file with the options - const cssPath = path.join(cssDirectory, descriptor.folder, descriptor.entry) - const outPath = path.join(__dirname, 'css', descriptor.folder) - let styleFile = `@-moz-document domain('${descriptor.options.namespace}') {\n` - styleFile += fs.readFileSync(cssPath, {encoding: 'UTF-8'}) - styleFile += '}' - fs.writeFileSync(cssPath, styleFile, {encoding: 'UTF-8'}) - userCss.create(cssPath, descriptor.options, outPath) + const cssPath = path.join(cssDirectory, descriptor.folder, descriptor.entry); + const outPath = path.join(__dirname, 'css', descriptor.folder); + let styleFile = `@-moz-document domain('${descriptor.options.namespace}') {\n`; + styleFile += fs.readFileSync(cssPath, {encoding: 'UTF-8'}); + styleFile += '}'; + fs.writeFileSync(cssPath, styleFile, {encoding: 'UTF-8'}); + userCss.create(cssPath, descriptor.options, outPath); } -}) +}); gulp.task('watch', () => { - gulp.watch('sass/**/*.s*', ['lint:js', 'lint:sass', 'build:dev']) -}) + gulp.watch('sass/**/*.s*', ['lint:js', 'lint:sass', 'build:dev']); +});