@discourse/lint-configs 1.0.0

package/.eslintrc.cjs

@@ -0,0 +1 @@
+module.exports = require("./eslintrc.cjs");

package/.prettierignore

@@ -0,0 +1 @@
+pnpm-lock.yaml

package/.prettierrc.cjs

@@ -0,0 +1,17 @@
+module.exports = {
+  plugins: ["prettier-plugin-ember-template-tag"],
+  overrides: [
+    {
+      files: "*.gjs",
+      options: {
+        parser: "ember-template-tag",
+      },
+    },
+    {
+      files: "*.gts",
+      options: {
+        parser: "ember-template-tag",
+      },
+    },
+  ],
+};

package/eslint-theme.cjs

@@ -0,0 +1,13 @@
+const eslint = require("./eslintrc.cjs");
+
+const config = { ...eslint };
+config.ignorePatterns = ["javascripts/vendor/*"];
+config.overrides.push({
+  files: ["*.js", "*.gjs"],
+  globals: {
+    settings: "readonly",
+    themePrefix: "readonly",
+  },
+});
+
+module.exports = config;

package/eslintrc.cjs

@@ -0,0 +1,208 @@
+"use strict";
+
+/* eslint-env node */
+
+// Copied from "ember-template-imports/lib/utils"
+const TEMPLATE_TAG_PLACEHOLDER = "__GLIMMER_TEMPLATE";
+
+module.exports = {
+  root: true,
+  parser: "@babel/eslint-parser",
+  env: {
+    browser: true,
+    builtin: true,
+    es6: true,
+    node: true,
+  },
+  parserOptions: {
+    ecmaVersion: 2018,
+    sourceType: "module",
+    requireConfigFile: false,
+    babelOptions: {
+      plugins: [["@babel/plugin-proposal-decorators", { legacy: true }]],
+    },
+  },
+  plugins: [
+    "ember",
+    "sort-class-members",
+    "decorator-position",
+    "simple-import-sort",
+  ],
+  globals: {
+    _: "off",
+    $: "readonly",
+    acceptance: "off",
+    asyncRender: "off",
+    Blob: "readonly",
+    bootbox: "off",
+    click: "off",
+    count: "off",
+    currentPath: "off",
+    currentRouteName: "off",
+    currentURL: "off",
+    currentUser: "off",
+    define: "readonly",
+    Discourse: "off",
+    Ember: "off",
+    exists: "off",
+    File: "readonly",
+    fillIn: "off",
+    find: "off",
+    getSettledState: "off",
+    globalThis: "readonly",
+    hasModule: "off",
+    invisible: "off",
+    jQuery: "off",
+    keyboardHelper: "off",
+    keyEvent: "off",
+    moduleFor: "off",
+    moment: "readonly",
+    pauseTest: "readonly",
+    Pretender: "off",
+    Promise: "readonly",
+    query: "off",
+    queryAll: "off",
+    QUnit: "off",
+    require: "readonly",
+    requirejs: "readonly",
+    sandbox: "off",
+    sinon: "off",
+    test: "off",
+    testDone: "off",
+    testStart: "off",
+    triggerEvent: "off",
+    visible: "off",
+    visit: "off",
+    waitUntil: "off",
+  },
+  rules: {
+    "block-scoped-var": 2,
+    "dot-notation": 0,
+    eqeqeq: [2, "allow-null"],
+    "guard-for-in": 2,
+    "no-alert": 2,
+    "no-bitwise": 2,
+    "no-caller": 2,
+    "no-cond-assign": 0,
+    "no-console": 2,
+    "no-debugger": 2,
+    "no-empty": 0,
+    "no-eval": 2,
+    "no-extend-native": 2,
+    "no-extra-parens": 0,
+    "no-inner-declarations": 2,
+    "no-irregular-whitespace": 2,
+    "no-iterator": 2,
+    "no-loop-func": 2,
+    "no-mixed-spaces-and-tabs": 2,
+    "no-multi-str": 2,
+    "no-new": 2,
+    "no-plusplus": 0,
+    "no-proto": 2,
+    "no-script-url": 2,
+    "no-sequences": 2,
+    "no-shadow": 2,
+    "no-this-before-super": 2,
+    "no-trailing-spaces": 2,
+    "no-undef": 2,
+    "no-unused-vars": 2,
+    "no-with": 2,
+    "no-var": 2,
+    radix: 2,
+    semi: 2,
+    strict: 0,
+    "valid-typeof": 2,
+    "wrap-iife": [2, "inside"],
+    curly: 2,
+    "no-duplicate-imports": 2,
+    "object-shorthand": ["error", "properties"],
+    "no-dupe-class-members": 2,
+    "sort-class-members/sort-class-members": [
+      2,
+      {
+        order: [
+          "[static-properties]",
+          "[static-methods]",
+          "[injected-services]",
+          "[injected-controllers]",
+          "[tracked-properties]",
+          "[properties]",
+          "[private-properties]",
+          "constructor",
+          "[everything-else]",
+          "[template-tag]",
+        ],
+        groups: {
+          // https://github.com/ember-cli/eslint-plugin-ember/issues/1896
+          // This only sort of works: in addition to the issues mentioned
+          // above, it doesn't seem to reliably enforce the order, e.g.
+          // [injected-services] -> <template> -> [injected-services]
+          // doesn't seem to trigger the error. That being said, it does
+          // work sometimes and this is needed to avoid emitting errors
+          // in the limited cases where it does work.
+          "template-tag": [
+            { type: "property", name: `/${TEMPLATE_TAG_PLACEHOLDER}/` },
+          ],
+          "injected-services": [
+            { groupByDecorator: "service", type: "property" },
+          ],
+          "injected-controllers": [
+            { groupByDecorator: "controller", type: "property" },
+          ],
+          "tracked-properties": [
+            { groupByDecorator: "tracked", type: "property" },
+          ],
+          "private-properties": [
+            { type: "property", private: true },
+            { type: "property", name: "/_.+/" },
+          ],
+        },
+        accessorPairPositioning: "getThenSet",
+        stopAfterFirstProblem: false,
+      },
+    ],
+    "decorator-position/decorator-position": ["error", { printWidth: 80 }],
+    "simple-import-sort/imports": [
+      "error",
+      {
+        groups: [
+          [
+            // Ember/glimmer
+            "^@glimmer/",
+            "^@ember/",
+            // Any other packages ('longest match wins')
+            "",
+            // Internal
+            "^discourse/",
+            "^discourse-common/",
+            "^discourse-.+",
+            "^admin/",
+            "^wizard/",
+            "^I18n$",
+            "^select-kit/",
+            "^float-kit/",
+            "^truth-helpers/",
+            // Plugins
+            "^discourse/plugins/",
+            // Relative
+            "^\\.\\./",
+            "^\\./",
+          ],
+        ],
+      },
+    ],
+  },
+
+  // https://github.com/ember-cli/eslint-plugin-ember/issues/1895
+  // We may eventually be able to drop this by extending the base
+  // config from eslint-plugin-ember. In the meantime, this
+  overrides: [
+    {
+      files: ["**/*.gjs", "**/*.gts"],
+      processor: "ember/<template>",
+      globals: {
+        [TEMPLATE_TAG_PLACEHOLDER]: "readonly",
+      },
+    },
+  ],
+};

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@discourse/lint-configs",
+  "version": "1.0.0",
+  "description": "Shareable lint configs for Discourse core, plugins, and themes",
+  "author": "Discourse",
+  "license": "MIT",
+  "keywords": [
+    "discourse"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/discourse/eslint-config-discourse.git"
+  },
+  "homepage": "https://github.com/discourse/eslint-config-discourse#readme",
+  "type": "module",
+  "exports": {
+    "./eslint": {
+      "require": "./eslintrc.cjs"
+    },
+    "./eslint-theme": {
+      "require": "./eslint-theme.cjs"
+    },
+    "./prettier": {
+      "require": "./.prettierrc.cjs"
+    },
+    "./template-lint": {
+      "require": "./template-lint.config.cjs"
+    }
+  },
+  "scripts": {
+    "lint": "eslint --no-error-on-unmatched-pattern **/*.cjs **/*.js && pnpm prettier --check .",
+    "test": "cd ../test && node test.js"
+  },
+  "dependencies": {
+    "@babel/core": "^7.23.2",
+    "@babel/eslint-parser": "^7.22.15",
+    "@babel/plugin-proposal-decorators": "^7.23.2",
+    "ember-template-lint": "^5.11.2",
+    "eslint": "^8.51.0",
+    "eslint-plugin-decorator-position": "^5.0.2",
+    "eslint-plugin-ember": "^11.11.1",
+    "eslint-plugin-simple-import-sort": "^10.0.0",
+    "eslint-plugin-sort-class-members": "^1.19.0",
+    "globals": "^13.23.0",
+    "prettier": "^2.8.8",
+    "prettier-plugin-ember-template-tag": "^0.3.2"
+  },
+  "peerDependencies": {
+    "ember-template-lint": "^5.11.2",
+    "eslint": "^8.51.0",
+    "prettier": "^2.8.8"
+  }
+}

package/template-lint.config.cjs

@@ -0,0 +1,33 @@
+module.exports = {
+  extends: ["recommended", "stylistic"],
+  rules: {
+    "no-positive-tabindex": false,
+    "no-autofocus-attribute": false,
+    "require-mandatory-role-attributes": false,
+    "require-media-caption": false,
+
+    // GJS compatibility
+    "modifier-name-case": false,
+
+    // Pending
+    "require-presentational-children": false,
+    "no-duplicate-landmark-elements": false,
+    "no-passed-in-event-handlers": false,
+    "no-inline-styles": false,
+    "no-link-to-tagname": false,
+    "no-implicit-this": false,
+    "require-valid-alt-text": false,
+    "link-href-attributes": false,
+    "no-curly-component-invocation": false,
+    "no-link-to-positional-params": false,
+    "require-input-label": false,
+    "no-route-action": false,
+    "no-action": false,
+
+    // Prettier compatibility
+    "eol-last": false,
+    "self-closing-void-elements": false,
+    "block-indentation": false,
+    quotes: false,
+  },
+};