Update yarn

Add Prettier
Improve eslint config
Add lint-staged and Husky
Add formatter settings + extension recommendation

Editorconfig clarification

Author: imjuniper

.editorconfig

@@ -1,12 +1,22 @@
 # editorconfig.org
-
 root = true
 
 [*]
 charset = utf-8
+indent_style = tab
+end_of_line = lf
 insert_final_newline = true
 trim_trailing_whitespace = true
+max_line_length = 100
+
+# Markdown syntax specifies that trailing whitespaces can be meaningful,
+# so let’s not trim those. e.g. 2 trailing spaces = linebreak (<br />)
+# See https://daringfireball.net/projects/markdown/syntax#p
+[*.md]
+trim_trailing_whitespace = false
 
-[*.{html,css}]
+# YAML forbids using tabs.
+# See https://yaml.org/faq.html
+[*.{yml,yaml}]
 indent_size = 2
 indent_style = space

.eslintignore

@@ -0,0 +1,3 @@
+.pnp.*
+.yarn/*
+web/js/vendor/

.eslintrc.cjs

@@ -0,0 +1,23 @@
+module.exports = {
+	root: true,
+	parserOptions: {
+		ecmaVersion: 'latest'
+	},
+	extends: ['eslint:recommended', 'plugin:editorconfig/noconflict', 'prettier'],
+	plugins: ['editorconfig'],
+	ignorePatterns: ['*.cjs'],
+	env: {
+		browser: true,
+		es2021: true
+	},
+	globals: {
+		$: 'readonly',
+		jQuery: 'readonly',
+		App: 'readonly'
+	},
+	rules: {
+		'no-unused-vars': 'off',
+		'no-undef': 'off',
+		'no-redeclare': 'off'
+	}
+};

.github/workflows/lint.yml

@@ -19,12 +19,28 @@ jobs:
       with:
         severity: error
 
+  prettier:
+    name: Prettier
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          cache: yarn
+          cache-dependency-path: yarn.lock
+
+      - name: Install Node packages
+        run: yarn install --frozen-lockfile
+
+      - name: Run Prettier
+        run: yarn prettier --check .
+
   eslint:
     name: ESLint
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: web
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
@@ -33,20 +49,17 @@ jobs:
         uses: actions/setup-node@v3
         with:
           cache: yarn
-          cache-dependency-path: web/yarn.lock
+          cache-dependency-path: yarn.lock
 
       - name: Install Node packages
         run: yarn install --frozen-lockfile
 
       - name: Run ESLint
-        run: yarn eslint js
+        run: yarn eslint web/js/
 
   stylelint:
     name: Stylelint
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: web
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
@@ -55,10 +68,10 @@ jobs:
         uses: actions/setup-node@v3
         with:
           cache: yarn
-          cache-dependency-path: web/yarn.lock
+          cache-dependency-path: yarn.lock
 
       - name: Install Node packages
         run: yarn install --frozen-lockfile
 
       - name: Run Stylelint
-        run: yarn stylelint css/src/themes/*.css
+        run: yarn stylelint web/css/src/themes/*.css

.gitignore

@@ -5,15 +5,32 @@
 *.bz2
 *.deb
 
-.vscode
+.vs
+.nova
+/.idea/
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
 .DS_Store
 
 .env
 composer.phar
 test/vendor/
 test/node_modules/
+web/src/vendor/filp
+web/src/vendor/psr
+web/src/vendor/composer/installed.json
 npm-debug.log
 .phpunit.result.cache
-.vs
-.nova
-/.idea/
+
+# Yarn (not zero-installs)
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn lint-staged

.lintstagedrc.cjs

@@ -0,0 +1,8 @@
+module.exports = {
+	// Run Stylelint on CSS files
+	'*.css': 'stylelint --fix',
+	// Run ESLint on TS, TSX, JS, JSX files
+	'*.{ts,js}?(x)': 'eslint --fix',
+	// Run Prettier everywhere
+	'*': 'prettier --write --ignore-unknown'
+};

.prettierignore

@@ -0,0 +1,33 @@
+.DS_Store
+
+# Minified files
+*.min.css
+*.min.js
+
+# Nginx files (for now)
+**/nginx/
+
+# Web templates (for now)
+web/templates/
+
+# Vendor/packages
+.pnp.*
+.yarn/*
+vendor/
+composer.phar
+composer.json
+composer.lock
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+# PNPM, NPM and YARN
+pnpm-lock.yaml
+package-lock.json
+yarn.lock

.prettierrc.cjs

@@ -0,0 +1,4 @@
+module.exports = {
+	phpVersion: "8.1",
+	braceStyle: "1tbs",
+};

.stylelintrc.cjs

@@ -0,0 +1,12 @@
+module.exports = {
+	extends: ['stylelint-config-standard', 'stylelint-config-prettier'],
+	rules: {
+		'selector-class-pattern': null,
+		'no-descending-specificity': null,
+		'block-no-empty': null,
+
+		'max-line-length': null,
+		'declaration-block-no-shorthand-property-overrides': null,
+		'selector-id-pattern': null
+	}
+}