Merge pull request #331 from getmango/feature/eslint

Add ESLint
getmango · Aug 19, 2022 · 76b4666 · 76b4666
2 parents 2597b4c + 5bdeca9
commit 76b4666
Show file tree

Hide file tree

Showing 20 changed files with 1,819 additions and 1,699 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,11 @@
+module.exports = {
+  parser: '@babel/eslint-parser',
+  parserOptions: { requireConfigFile: false },
+  plugins: ['prettier'],
+  rules: {
+    eqeqeq: ['error', 'always'],
+    'object-shorthand': ['error', 'always'],
+    'prettier/prettier': 'error',
+    'no-var': 'error',
+  },
+};
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,6 @@
+{
+    "singleQuote": true,
+    "trailingComma": "all",
+    "printWidth": 80,
+    "tabWidth": 2
+}
diff --git a/Makefile b/Makefile
@@ -29,6 +29,7 @@ test:
 check:
 	crystal tool format --check
 	./bin/ameba
+	yarn lint
 
 arm32v7:
 	crystal build src/mango.cr --release --progress --error-trace --cross-compile --target='arm-linux-gnueabihf' -o mango-arm32v7

diff --git a/gulpfile.js b/gulpfile.js
@@ -5,63 +5,78 @@ const minifyCss = require('gulp-minify-css');
 const less = require('gulp-less');
 
 gulp.task('copy-img', () => {
-	return gulp.src('node_modules/uikit/src/images/backgrounds/*.svg')
-		.pipe(gulp.dest('public/img'));
+  return gulp
+    .src('node_modules/uikit/src/images/backgrounds/*.svg')
+    .pipe(gulp.dest('public/img'));
 });
 
 gulp.task('copy-font', () => {
-	return gulp.src('node_modules/@fortawesome/fontawesome-free/webfonts/fa-solid-900.woff**')
-		.pipe(gulp.dest('public/webfonts'));
+  return gulp
+    .src(
+      'node_modules/@fortawesome/fontawesome-free/webfonts/fa-solid-900.woff**',
+    )
+    .pipe(gulp.dest('public/webfonts'));
 });
 
 // Copy files from node_modules
 gulp.task('node-modules-copy', gulp.parallel('copy-img', 'copy-font'));
 
 // Compile less
 gulp.task('less', () => {
-	return gulp.src([
-			'public/css/mango.less',
-			'public/css/tags.less'
-		])
-		.pipe(less())
-		.pipe(gulp.dest('public/css'));
+  return gulp
+    .src(['public/css/mango.less', 'public/css/tags.less'])
+    .pipe(less())
+    .pipe(gulp.dest('public/css'));
 });
 
 // Transpile and minify JS files and output to dist
 gulp.task('babel', () => {
-	return gulp.src(['public/js/*.js', '!public/js/*.min.js'])
-		.pipe(babel({
-			presets: [
-				['@babel/preset-env', {
-					targets: '>0.25%, not dead, ios>=9'
-				}]
-			],
-		}))
-		.pipe(minify({
-			removeConsole: true,
-			builtIns: false
-		}))
-		.pipe(gulp.dest('dist/js'));
+  return gulp
+    .src(['public/js/*.js', '!public/js/*.min.js'])
+    .pipe(
+      babel({
+        presets: [
+          [
+            '@babel/preset-env',
+            {
+              targets: '>0.25%, not dead, ios>=9',
+            },
+          ],
+        ],
+      }),
+    )
+    .pipe(
+      minify({
+        removeConsole: true,
+        builtIns: false,
+      }),
+    )
+    .pipe(gulp.dest('dist/js'));
 });
 
 // Minify CSS and output to dist
 gulp.task('minify-css', () => {
-	return gulp.src('public/css/*.css')
-		.pipe(minifyCss())
-		.pipe(gulp.dest('dist/css'));
+  return gulp
+    .src('public/css/*.css')
+    .pipe(minifyCss())
+    .pipe(gulp.dest('dist/css'));
 });
 
 // Copy static files (includeing images) to dist
 gulp.task('copy-files', () => {
-	return gulp.src([
-			'public/*.*',
-			'public/img/**',
-			'public/webfonts/*',
-			'public/js/*.min.js'
-		], {
-			base: 'public'
-		})
-		.pipe(gulp.dest('dist'));
+  return gulp
+    .src(
+      [
+        'public/*.*',
+        'public/img/**',
+        'public/webfonts/*',
+        'public/js/*.min.js',
+      ],
+      {
+        base: 'public',
+      },
+    )
+    .pipe(gulp.dest('dist'));
 });
 
 // Set up the public folder for development

diff --git a/package.json b/package.json
@@ -6,17 +6,22 @@
 	"author": "Alex Ling <[email protected]>",
 	"license": "MIT",
 	"devDependencies": {
+		"@babel/eslint-parser": "^7.18.9",
 		"@babel/preset-env": "^7.11.5",
 		"all-contributors-cli": "^6.19.0",
+		"eslint": "^8.22.0",
+		"eslint-plugin-prettier": "^4.2.1",
 		"gulp": "^4.0.2",
 		"gulp-babel": "^8.0.0",
 		"gulp-babel-minify": "^0.5.1",
 		"gulp-less": "^4.0.1",
 		"gulp-minify-css": "^1.2.4",
-		"less": "^3.11.3"
+		"less": "^3.11.3",
+		"prettier": "^2.7.1"
 	},
 	"scripts": {
-		"uglify": "gulp"
+		"uglify": "gulp",
+		"lint": "eslint public/js *.js --ext .js"
 	},
 	"dependencies": {
 		"@fortawesome/fontawesome-free": "^5.14.0",

diff --git a/public/js/admin.js b/public/js/admin.js
@@ -1,58 +1,56 @@
 const component = () => {
-	return {
-		progress: 1.0,
-		generating: false,
-		scanning: false,
-		scanTitles: 0,
-		scanMs: -1,
-		themeSetting: '',
+  return {
+    progress: 1.0,
+    generating: false,
+    scanning: false,
+    scanTitles: 0,
+    scanMs: -1,
+    themeSetting: '',
 
-		init() {
-			this.getProgress();
-			setInterval(() => {
-				this.getProgress();
-			}, 5000);
+    init() {
+      this.getProgress();
+      setInterval(() => {
+        this.getProgress();
+      }, 5000);
 
-			const setting = loadThemeSetting();
-			this.themeSetting = setting.charAt(0).toUpperCase() + setting.slice(1);
-		},
-		themeChanged(event) {
-			const newSetting = $(event.currentTarget).val().toLowerCase();
-			saveThemeSetting(newSetting);
-			setTheme();
-		},
-		scan() {
-			if (this.scanning) return;
-			this.scanning = true;
-			this.scanMs = -1;
-			this.scanTitles = 0;
-			$.post(`${base_url}api/admin/scan`)
-				.then(data => {
-					this.scanMs = data.milliseconds;
-					this.scanTitles = data.titles;
-				})
-				.catch(e => {
-					alert('danger', `Failed to trigger a scan. Error: ${e}`);
-				})
-				.always(() => {
-					this.scanning = false;
-				});
-		},
-		generateThumbnails() {
-			if (this.generating) return;
-			this.generating = true;
-			this.progress = 0.0;
-			$.post(`${base_url}api/admin/generate_thumbnails`)
-				.then(() => {
-					this.getProgress()
-				});
-		},
-		getProgress() {
-			$.get(`${base_url}api/admin/thumbnail_progress`)
-				.then(data => {
-					this.progress = data.progress;
-					this.generating = data.progress > 0;
-				});
-		},
-	};
+      const setting = loadThemeSetting();
+      this.themeSetting = setting.charAt(0).toUpperCase() + setting.slice(1);
+    },
+    themeChanged(event) {
+      const newSetting = $(event.currentTarget).val().toLowerCase();
+      saveThemeSetting(newSetting);
+      setTheme();
+    },
+    scan() {
+      if (this.scanning) return;
+      this.scanning = true;
+      this.scanMs = -1;
+      this.scanTitles = 0;
+      $.post(`${base_url}api/admin/scan`)
+        .then((data) => {
+          this.scanMs = data.milliseconds;
+          this.scanTitles = data.titles;
+        })
+        .catch((e) => {
+          alert('danger', `Failed to trigger a scan. Error: ${e}`);
+        })
+        .always(() => {
+          this.scanning = false;
+        });
+    },
+    generateThumbnails() {
+      if (this.generating) return;
+      this.generating = true;
+      this.progress = 0.0;
+      $.post(`${base_url}api/admin/generate_thumbnails`).then(() => {
+        this.getProgress();
+      });
+    },
+    getProgress() {
+      $.get(`${base_url}api/admin/thumbnail_progress`).then((data) => {
+        this.progress = data.progress;
+        this.generating = data.progress > 0;
+      });
+    },
+  };
 };
diff --git a/public/js/alert.js b/public/js/alert.js
@@ -1,6 +1,6 @@
 const alert = (level, text) => {
-	$('#alert').empty();
-	const html = `<div class="uk-alert-${level}" uk-alert><a class="uk-alert-close" uk-close></a><p>${text}</p></div>`;
-	$('#alert').append(html);
-	$("html, body").animate({ scrollTop: 0 });
+  $('#alert').empty();
+  const html = `<div class="uk-alert-${level}" uk-alert><a class="uk-alert-close" uk-close></a><p>${text}</p></div>`;
+  $('#alert').append(html);
+  $('html, body').animate({ scrollTop: 0 });
 };