diff --git a/.eslintrc.yml b/.eslintrc.yml index f853c82..4a51fe3 100644 --- a/.eslintrc.yml +++ b/.eslintrc.yml @@ -11,14 +11,16 @@ env: jest: true node: true + googleappsscript/googleappsscript: true ############### # Parser vars # ############### parser: '@typescript-eslint/parser' parserOptions: + project: true ecmaVersion: 2018 - sourceType: script + sourceType: module ########### # Plugins # @@ -26,10 +28,9 @@ parserOptions: extends: - 'eslint:recommended' - 'plugin:prettier/recommended' + - 'plugin:@typescript-eslint/recommended-type-checked' + - 'plugin:@typescript-eslint/stylistic-type-checked' plugins: - '@typescript-eslint' + - 'googleappsscript' - 'jest' -######### -# Rules # -######### -# rules: diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml index 483ae7b..e26555f 100644 --- a/.github/workflows/linter.yml +++ b/.github/workflows/linter.yml @@ -1,58 +1,48 @@ --- -########################### -########################### -## Linter GitHub Actions ## -########################### -########################### name: Lint Code Base -# -# Documentation: -# https://help.github.com/en/articles/workflow-syntax-for-github-actions -# +on: # yamllint disable-line rule:truthy + push: null + pull_request: null -############################# -# Start the job on all push # -############################# -on: - push: - # branches-ignore: [main] - # Remove the line above to run when pushing to main - pull_request: - branches: [main] - -############### -# Set the Job # -############### jobs: build: - # Name the Job - name: Lint Code Base - # Set the agent to run on + name: Lint runs-on: ubuntu-latest - ################## - # Load all steps # - ################## + permissions: + contents: read + packages: read + # To report GitHub Actions status checks + statuses: write + steps: - ########################## - # Checkout the code base # - ########################## - - name: Checkout Code + - name: Checkout code uses: actions/checkout@v4 with: - # Full git history is needed to get a proper list of changed files within `super-linter` + # super-linter needs the full git history to get the + # list of files that changed across commits fetch-depth: 0 - - ################################ - # Run Linter against code base # - ################################ - - name: Lint Code Base - uses: github/super-linter/slim@v5 # uses: github/super-linter@v4 See https://github.com/github/super-linter#images + - name: Setup Node.js environment + uses: actions/setup-node@v4 + with: + node-version: '20' + - name: Cache node modules + uses: actions/cache@v4 + with: + path: ~/.npm + key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} + restore-keys: | + ${{ runner.os }}-node- + - name: Install dependencies + run: npm ci + - name: Super-linter + uses: super-linter/super-linter/slim@v5 # x-release-please-version env: - VALIDATE_ALL_CODEBASE: true + DEFAULT_BRANCH: main + JAVASCRIPT_ES_CONFIG_FILE: .eslintrc.yml LINTER_RULES_PATH: / + VALIDATE_ALL_CODEBASE: true VALIDATE_JAVASCRIPT_ES: true - JAVASCRIPT_ES_CONFIG_FILE: .eslintrc.yml - DEFAULT_BRANCH: main + # To report GitHub Actions status checks GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/jest.config.js b/jest.config.js index 1fb9bf1..70f8ced 100644 --- a/jest.config.js +++ b/jest.config.js @@ -18,7 +18,7 @@ module.exports = { moduleFileExtensions: ['js', 'ts', 'tsx', 'json'], preset: 'ts-jest', testEnvironment: 'node', - testMatch: ['**/__tests__/**/*.[jt]s?(x)'], + testMatch: ['**/tests/**/*.[jt]s?(x)'], transform: { '^.+\\.tsx?$': 'ts-jest', }, diff --git a/package-lock.json b/package-lock.json index 655f555..a94f31e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -16,6 +16,7 @@ "@typescript-eslint/parser": "^6.21.0", "eslint": "^8.47.0", "eslint-config-prettier": "^9.1.0", + "eslint-plugin-googleappsscript": "^1.0.5", "eslint-plugin-prettier": "^5.1.3", "jest": "^29.7.0", "prettier": "^3.0.3", @@ -3026,6 +3027,18 @@ "eslint": ">=7.0.0" } }, + "node_modules/eslint-plugin-googleappsscript": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/eslint-plugin-googleappsscript/-/eslint-plugin-googleappsscript-1.0.5.tgz", + "integrity": "sha512-pzGdRAoGzjefsGs1ct1MSip9RbBn24xJd/CxD2bszDU3HkuFYenAg/tpTGQQSb2hYMre0uL/H3IIGhN4qSnQTA==", + "dev": true, + "dependencies": { + "requireindex": "~1.1.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/eslint-plugin-prettier": { "version": "5.1.3", "resolved": "https://registry.npmjs.org/eslint-plugin-prettier/-/eslint-plugin-prettier-5.1.3.tgz", @@ -6560,6 +6573,15 @@ "node": ">=0.10.0" } }, + "node_modules/requireindex": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/requireindex/-/requireindex-1.1.0.tgz", + "integrity": "sha512-LBnkqsDE7BZKvqylbmn7lTIVdpx4K/QCduRATpO5R+wtPmky/a8pN1bO2D6wXppn1497AJF9mNjqAXr6bdl9jg==", + "dev": true, + "engines": { + "node": ">=0.10.5" + } + }, "node_modules/requires-port": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/requires-port/-/requires-port-1.0.0.tgz", diff --git a/package.json b/package.json index 28312b8..b6fa8b5 100644 --- a/package.json +++ b/package.json @@ -31,6 +31,7 @@ "@typescript-eslint/parser": "^6.21.0", "eslint": "^8.47.0", "eslint-config-prettier": "^9.1.0", + "eslint-plugin-googleappsscript": "^1.0.5", "eslint-plugin-prettier": "^5.1.3", "jest": "^29.7.0", "prettier": "^3.0.3", diff --git a/src/sheetsl.ts b/src/sheetsl.ts index cb3d37c..96e05bd 100644 --- a/src/sheetsl.ts +++ b/src/sheetsl.ts @@ -60,6 +60,14 @@ type DeepLTranslationObj = { */ export type DeepLLanguageType = 'source' | 'target'; +/** + * The type of the object containing key-values pairs to set in the properties of the Google Apps Script. + * @see https://developers.google.com/apps-script/reference/properties/properties#setpropertiesproperties + */ +type PropertiesObj = { + [key: string]: string; +}; + /** * Create add-on menu on opening spreadsheet file. */ @@ -105,8 +113,8 @@ export function setDeeplAuthKey(): void { `[${ADDON_NAME}] Completed: Your DeepL API Authentication Key has been saved as a user property.`, ); } catch (error) { - console.error(error.stack); - ui.alert(error.message); + console.error((error as Error).stack); + ui.alert((error as Error).message); } } @@ -147,8 +155,8 @@ export function deleteDeeplAuthKey(): void { `[${ADDON_NAME}] Complete: DeepL API Authentication Key has been deleted from your user property.`, ); } catch (error) { - console.error(error.stack); - ui.alert(error.message); + console.error((error as Error).stack); + ui.alert((error as Error).message); } } @@ -233,15 +241,15 @@ export function setLanguage(): void { ); } // Set the values as user properties - let setObj = {}; + let setObj: PropertiesObj = {}; setObj[UP_KEY_SOURCE_LOCALE] = responseSourceLocale; setObj[UP_KEY_TARGET_LOCALE] = responseTargetLocale; up.setProperties(setObj, false); // Complete ui.alert('Completed: Language setting has been completed.'); } catch (error) { - console.error(error.stack); - ui.alert(error.message); + console.error((error as Error).stack); + ui.alert((error as Error).message); } } @@ -318,8 +326,8 @@ export function translateRange(): void { // Complete ui.alert('Complete: Translation has been completed.'); } catch (error) { - console.error(error.stack); - ui.alert(error.message); + console.error((error as Error).stack); + ui.alert((error as Error).message); } } diff --git a/__tests__/deepL.test.ts b/tests/deepL.test.ts similarity index 100% rename from __tests__/deepL.test.ts rename to tests/deepL.test.ts diff --git a/__tests__/getBytes.test.ts b/tests/getBytes.test.ts similarity index 100% rename from __tests__/getBytes.test.ts rename to tests/getBytes.test.ts diff --git a/__tests__/getDeepLApiBaseUrl.test.ts b/tests/getDeepLApiBaseUrl.test.ts similarity index 100% rename from __tests__/getDeepLApiBaseUrl.test.ts rename to tests/getDeepLApiBaseUrl.test.ts diff --git a/__tests__/getDeepLApiKey.test.ts b/tests/getDeepLApiKey.test.ts similarity index 100% rename from __tests__/getDeepLApiKey.test.ts rename to tests/getDeepLApiKey.test.ts diff --git a/__tests__/handleDeepLErrors.test.ts b/tests/handleDeepLErrors.test.ts similarity index 100% rename from __tests__/handleDeepLErrors.test.ts rename to tests/handleDeepLErrors.test.ts diff --git a/__tests__/onInstallonOpen.test.ts b/tests/onInstallonOpen.test.ts similarity index 100% rename from __tests__/onInstallonOpen.test.ts rename to tests/onInstallonOpen.test.ts diff --git a/__tests__/verifyAuthKeyPrompt.test.ts b/tests/verifyAuthKeyPrompt.test.ts similarity index 100% rename from __tests__/verifyAuthKeyPrompt.test.ts rename to tests/verifyAuthKeyPrompt.test.ts diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..2b3161e --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,110 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "ES2018" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */, + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + + /* Modules */ + // "module": "commonjs", /* Specify what module code is generated. */ + // "rootDir": "./", /* Specify the root folder within your source files. */ + // "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ + // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ + // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ + // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + "allowJs": true /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */, + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + + /* Emit */ + // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + "outDir": "dist" /* Specify an output folder for all emitted files. */, + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */, + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */, + + /* Type Checking */ + "strict": true /* Enable all strict type-checking options. */, + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + }, + "include": ["src/**/*.ts"] +}