Rework extensions folder to use paranext-multi-extension-template

.eslintignore

@@ -23,6 +23,7 @@ node_modules
 release/app/dist
 release/build
 .erb/dll
+dev-appdata
 
 .idea
 npm-debug.log.*

.eslintrc.js

@@ -11,6 +11,8 @@ module.exports = {
   ],
 
   rules: {
+    // #region shared with https://github.com/paranext/paranext-multi-extension-template/blob/main/.eslintrc.cjs and https://github.com/paranext/paranext-extension-template/blob/main/.eslintrc.js except certain overrides
+
     // #region ERB rules
 
     'import/extensions': 'off',
@@ -23,7 +25,7 @@ module.exports = {
 
     // #endregion
 
-    // #region Paranext rules
+    // #region Platform.Bible rules
 
     // Rules in each section are generally in alphabetical order. However, several
     // `@typescript-eslint` rules require disabling the equivalent ESLint rule. So in these cases
@@ -89,6 +91,8 @@ module.exports = {
     'react/require-default-props': 'off',
 
     // #endregion
+
+    // #endregion
   },
   globals: {
     globalThis: 'readonly',

.prettierignore

@@ -23,6 +23,7 @@ node_modules
 release/app/dist
 release/build
 .erb/dll
+dev-appdata
 
 .idea
 npm-debug.log.*

.prettierrc.js

@@ -1,4 +1,5 @@
-// Please keep this file in sync with the .prettierrc.js file in the paranext-extension-template repo
+// #region shared with https://github.com/paranext/paranext-multi-extension-template/blob/main/.prettierrc.js and https://github.com/paranext/paranext-extension-template/blob/main/.prettierrc.js
+
 module.exports = {
   tabWidth: 2,
   trailingComma: 'all',
@@ -14,3 +15,5 @@ module.exports = {
     },
   ],
 };
+
+// #endregion

.stylelintignore

@@ -23,6 +23,7 @@ node_modules
 release/app/dist
 release/build
 .erb/dll
+dev-appdata
 
 .idea
 npm-debug.log.*

.stylelintrc.js

@@ -1,4 +1,5 @@
-// Please keep this file in sync with the .stylelintrc.js file in the paranext-extension-template repo
+// #region shared with https://github.com/paranext/paranext-multi-extension-template/blob/main/.stylelintrc.js and https://github.com/paranext/paranext-extension-template/blob/main/.stylelintrc.js
+
 module.exports = {
   extends: ['stylelint-config-recommended', 'stylelint-config-sass-guidelines'],
   overrides: [
@@ -16,3 +17,5 @@ module.exports = {
     'selector-max-id': 1,
   },
 };
+
+// #endregion

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022-present SIL International
+Copyright (c) 2022-2024 SIL International
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

extensions/.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 100
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.cs]
+indent_size = 4

extensions/.eslintignore

@@ -1,9 +1,35 @@
+# #region shared with https://github.com/paranext/paranext-extension-template/blob/main/.eslintignore
+
 # Please keep this file in sync with .prettierignore and .stylelintignore
 
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
 # Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
 
+# OSX
+.DS_Store
+
+.idea
+npm-debug.log.*
+*.css.d.ts
+*.sass.d.ts
+*.scss.d.ts
+
 # Built files
 dist
 release
 temp-build
+
+# generated files
+package-lock.json
+
+# #endregion

extensions/.eslintrc.cjs

@@ -1,7 +1,55 @@
+// #region shared with https://github.com/paranext/paranext-extension-template/blob/main/.eslintrc.js
+
 module.exports = {
-  extends: '../.eslintrc.js',
+  extends: [
+    // https://github.com/electron-react-boilerplate/eslint-config-erb/blob/main/index.js
+    // airbnb rules are embedded in erb https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb
+    'erb',
+    // Make sure this is last so it gets the chance to override other configs.
+    // See https://github.com/prettier/eslint-config-prettier and https://github.com/prettier/eslint-plugin-prettier
+    'plugin:prettier/recommended',
+  ],
+
   rules: {
-    'import/no-unresolved': ['error', { ignore: ['@papi'] }],
+    // Some rules in this following shared region are not applied since they are overridden in subsequent regions
+    // #region shared with https://github.com/paranext/paranext-core/blob/main/.eslintrc.js except certain overrides
+
+    // #region ERB rules
+
+    'import/extensions': 'off',
+    // A temporary hack related to IDE not resolving correct package.json
+    'import/no-extraneous-dependencies': 'off',
+    'import/no-import-module-exports': 'off',
+    'import/no-unresolved': 'error',
+    'react/jsx-filename-extension': 'off',
+    'react/react-in-jsx-scope': 'off',
+
+    // #endregion
+
+    // #region Platform.Bible rules
+
+    // Rules in each section are generally in alphabetical order. However, several
+    // `@typescript-eslint` rules require disabling the equivalent ESLint rule. So in these cases
+    // each ESLint rule is turned off immediately above the corresponding `@typescript-eslint` rule.
+    'import/no-anonymous-default-export': ['error', { allowCallExpression: false }],
+    '@typescript-eslint/explicit-member-accessibility': ['error', { accessibility: 'no-public' }],
+    'lines-between-class-members': 'off',
+    '@typescript-eslint/lines-between-class-members': [
+      'error',
+      'always',
+      { exceptAfterSingleLine: true, exceptAfterOverload: true },
+    ],
+    '@typescript-eslint/member-ordering': 'error',
+    'no-empty-function': 'off',
+    '@typescript-eslint/no-empty-function': [
+      'error',
+      {
+        allow: ['arrowFunctions', 'functions', 'methods'],
+      },
+    ],
+    '@typescript-eslint/no-explicit-any': 'error',
+    'no-redeclare': 'off',
+    '@typescript-eslint/no-redeclare': 'error',
     'no-restricted-imports': [
       'error',
       {
@@ -13,8 +61,57 @@ module.exports = {
         ],
       },
     ],
+    'no-shadow': 'off',
+    '@typescript-eslint/no-shadow': 'error',
+    'no-use-before-define': 'off',
+    '@typescript-eslint/no-use-before-define': [
+      'error',
+      { functions: false, allowNamedExports: true, typedefs: false, ignoreTypeReferences: true },
+    ],
+    '@typescript-eslint/no-unnecessary-type-assertion': 'error',
+    'no-unused-vars': 'off',
+    '@typescript-eslint/no-unused-vars': 'error',
+    'no-useless-constructor': 'off',
+    '@typescript-eslint/no-useless-constructor': 'error',
+    'comma-dangle': ['error', 'always-multiline'],
+    indent: 'off',
+    'jsx-a11y/label-has-associated-control': [
+      'error',
+      {
+        assert: 'either',
+      },
+    ],
+    // Should use our logger anytime you want logs that persist. Otherwise use console only in testing
+    'no-console': 'warn',
+    'no-null/no-null': 2,
+    'no-plusplus': ['error', { allowForLoopAfterthoughts: true }],
+    'no-type-assertion/no-type-assertion': 'error',
+    'prettier/prettier': ['warn', { tabWidth: 2, trailingComma: 'all' }],
+    'react/jsx-indent-props': ['warn', 2],
+    'react/jsx-props-no-spreading': ['error', { custom: 'ignore' }],
+    'react/require-default-props': 'off',
+
+    // #endregion
+
+    // #endregion
+
+    // #region Overrides to rules from paranext-core
+
+    'import/no-unresolved': ['error', { ignore: ['@papi'] }],
+
+    // #endregion
+  },
+  globals: {
+    globalThis: 'readonly',
   },
   overrides: [
+    {
+      // Allow this file to have overrides to rules from paranext-core
+      files: ['.eslintrc.*js'],
+      rules: {
+        'no-dupe-keys': 'off',
+      },
+    },
     {
       files: ['*.js'],
       rules: {
@@ -28,7 +125,25 @@ module.exports = {
         'import/prefer-default-export': 'off',
       },
     },
+    {
+      files: ['./lib/*', './webpack/*'],
+      rules: {
+        // These files are scripts not running in Platform.Bible, so they can't use the logger
+        'no-console': 'off',
+      },
+    },
   ],
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+    project: './tsconfig.json',
+    tsconfigRootDir: __dirname,
+    createDefaultProgram: true,
+  },
+  // Note: this folder's package.json does not contain these plugins or any other eslint packages
+  // because eslint was finding multiple copies of plugins and failing. So we use the packages from
+  // repo root instead
+  plugins: ['@typescript-eslint', 'no-type-assertion', 'no-null'],
   settings: {
     'import/resolver': {
       // See https://github.com/benmosher/eslint-plugin-import/issues/1396#issuecomment-575727774 for line below
@@ -45,3 +160,5 @@ module.exports = {
     },
   },
 };
+
+// #endregion

extensions/.gitignore

@@ -1,3 +1,5 @@
+# #region shared with https://github.com/paranext/paranext-extension-template/blob/main/.gitignore
+
 # Logs
 logs
 *.log
@@ -13,6 +15,9 @@ release
 dist-ssr
 *.local
 
+# formatting and linting
+.eslintcache
+
 # Editor directories and files
 .idea
 .DS_Store
@@ -24,3 +29,5 @@ dist-ssr
 
 # Temporary intermediate build files
 temp-build
+
+# #endregion

extensions/.prettierignore

@@ -1,9 +1,35 @@
+# #region shared with https://github.com/paranext/paranext-extension-template/blob/main/.prettierignore
+
 # Please keep this file in sync with .eslintignore and .stylelintignore
 
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
 # Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
 
+# OSX
+.DS_Store
+
+.idea
+npm-debug.log.*
+*.css.d.ts
+*.sass.d.ts
+*.scss.d.ts
+
 # Built files
 dist
 release
 temp-build
+
+# generated files
+package-lock.json
+
+# #endregion

extensions/.prettierrc.js

@@ -0,0 +1,19 @@
+// #region shared with https://github.com/paranext/paranext-core/blob/main/.prettierrc.js and https://github.com/paranext/paranext-extension-template/blob/main/.prettierrc.js
+
+module.exports = {
+  tabWidth: 2,
+  trailingComma: 'all',
+  endOfLine: 'lf',
+  singleQuote: true,
+  // prettier-plugin-jsdoc options
+  tsdoc: true,
+  plugins: ['prettier-plugin-jsdoc'],
+  overrides: [
+    {
+      files: '*.json',
+      options: { parser: 'json' },
+    },
+  ],
+};
+
+// #endregion