Add and configure ESLint and update configuration for Prettier (#617)

* Add ESLint, update Prettier

* Update docs

* Update tests

* Update licenses

* Fix review points

.eslintignore

@@ -0,0 +1,6 @@
+# Ignore list
+/*
+
+# Do not ignore these folders:
+!__tests__/
+!src/

.eslintrc.js

@@ -0,0 +1,49 @@
+module.exports = {
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:eslint-plugin-jest/recommended',
+    'eslint-config-prettier'
+  ],
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint', 'eslint-plugin-jest'],
+  rules: {
+    '@typescript-eslint/no-require-imports': 'error',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-empty-function': 'off',
+    '@typescript-eslint/ban-ts-comment': [
+      'error',
+      {
+        'ts-ignore': 'allow-with-description'
+      }
+    ],
+    'no-console': 'error',
+    'yoda': 'error',
+    'prefer-const': [
+      'error',
+      {
+        destructuring: 'all'
+      }
+    ],
+    'no-control-regex': 'off',
+    'no-constant-condition': ['error', {checkLoops: false}]
+  },
+  overrides: [
+    {
+      files: ['**/*{test,spec}.ts'],
+      rules: {
+        '@typescript-eslint/no-unused-vars': 'off',
+        'jest/no-standalone-expect': 'off',
+        'jest/no-conditional-expect': 'off',
+        'no-console': 'off',
+
+      }
+    }
+  ],
+  env: {
+    node: true,
+    es6: true,
+    'jest/globals': true
+  }
+};

.github/workflows/codeql-analysis.yml

@@ -2,7 +2,7 @@ name: CodeQL analysis
 
 on:
   push:
-    branches: [ 'main' ]
+    branches: ['main']
   pull_request:
   schedule:
     - cron: '0 3 * * 0'

.github/workflows/e2e-tests.yml

@@ -81,7 +81,7 @@ jobs:
         id: cp310
         uses: ./
         with:
-        python-version: "3.10"
+          python-version: '3.10'
       - name: Verify 3.10
         run: python __tests__/verify-python.py 3.10
       - name: Run python-path sample 3.10

.github/workflows/test-python.yml

@@ -185,7 +185,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [macos-latest, windows-latest, ubuntu-18.04, ubuntu-20.04]
-        python: ["3.7", "3.8", "3.9", "3.10"]
+        python: ['3.7', '3.8', '3.9', '3.10']
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -209,7 +209,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ["3.8", "3.9", "3.10"]
+        python-version: ['3.8', '3.9', '3.10']
     steps:
       - uses: actions/checkout@v3
       - name: Setup Python and check latest

.prettierignore

@@ -0,0 +1,7 @@
+# Ignore list
+/*
+
+# Do not ignore these folders:
+!__tests__/
+!.github/
+!src/

.prettierrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  printWidth: 80,
+  tabWidth: 2,
+  useTabs: false,
+  semi: true,
+  singleQuote: true,
+  trailingComma: 'none',
+  bracketSpacing: false,
+  arrowParens: 'avoid'
+};

.prettierrc.json

@@ -1,11 +0,0 @@
-{
-    "printWidth": 80,
-    "tabWidth": 2,
-    "useTabs": false,
-    "semi": true,
-    "singleQuote": true,
-    "trailingComma": "none",
-    "bracketSpacing": false,
-    "arrowParens": "avoid",
-    "parser": "typescript"
-  }

__tests__/cache-restore.test.ts

@@ -5,7 +5,6 @@ import * as exec from '@actions/exec';
 import * as io from '@actions/io';
 import {getCacheDistributor} from '../src/cache-distributions/cache-factory';
 import {State} from '../src/cache-distributions/cache-distributor';
-import * as constants from '../src/cache-distributions/constants';
 
 describe('restore-cache', () => {
   const pipFileLockHash =
@@ -95,7 +94,7 @@ virtualenvs.path = "{cache-dir}/virtualenvs"  # /Users/patrick/Library/Caches/py
       async packageManager => {
         expect(() =>
           getCacheDistributor(packageManager, '3.8.12', undefined)
-        ).toThrowError(`Caching for '${packageManager}' is not supported`);
+        ).toThrow(`Caching for '${packageManager}' is not supported`);
       }
     );
   });
@@ -210,7 +209,7 @@ virtualenvs.path = "{cache-dir}/virtualenvs"  # /Users/patrick/Library/Caches/py
           dependencyFile
         );
 
-        await expect(cacheDistributor.restoreCache()).rejects.toThrowError(
+        await expect(cacheDistributor.restoreCache()).rejects.toThrow(
           `No file in ${process.cwd()} matched to [${cacheDependencyPath
             .split('\n')
             .join(',')}], make sure you have checked out the target repository`
@@ -229,7 +228,7 @@ virtualenvs.path = "{cache-dir}/virtualenvs"  # /Users/patrick/Library/Caches/py
           pythonVersion,
           dependencyFile
         );
-        await expect(cacheDistributor.restoreCache()).resolves;
+        await expect(cacheDistributor.restoreCache()).resolves.not.toThrow();
       }
     );
 
@@ -239,16 +238,15 @@ virtualenvs.path = "{cache-dir}/virtualenvs"  # /Users/patrick/Library/Caches/py
     ])(
       'Should throw an error as there is no default file `pyproject.toml` to use when requirements.txt is not specified',
       async (packageManager, pythonVersion, dependencyFile) => {
-        jest.mock('../src/cache-distributions/constants', () => ({
-          CACHE_DEPENDENCY_BACKUP_PATH: '**/pyprojecttest.toml'
-        }));
-
         const cacheDistributor = getCacheDistributor(
           packageManager,
           pythonVersion,
           dependencyFile
-        );
+        ) as any; // Widening PipCache | PipenvCache | PoetryCache type to any allow us to change private property on the cacheDistributor to test value: "**/pyprojecttest.toml"
-        await expect(cacheDistributor.restoreCache()).resolves;
+
+        cacheDistributor.cacheDependencyBackupPath = '**/pyprojecttest.toml';
+
+        await expect(cacheDistributor.restoreCache()).rejects.toThrow();
       }
     );
   });

__tests__/cache-save.test.ts

@@ -116,22 +116,6 @@ describe('run', () => {
       );
       expect(setFailedSpy).not.toHaveBeenCalled();
     });
-
-    it('should not save cache for pipenv', async () => {
-      inputs['cache'] = 'pipenv';
-
-      await run();
-
-      expect(getInputSpy).toHaveBeenCalled();
-      expect(debugSpy).toHaveBeenCalledWith(
-        `paths for caching are ${__dirname}`
-      );
-      expect(getStateSpy).toHaveBeenCalledTimes(3);
-      expect(infoSpy).toHaveBeenCalledWith(
-        `Cache hit occurred on the primary key ${requirementsHash}, not saving cache.`
-      );
-      expect(setFailedSpy).not.toHaveBeenCalled();
-    });
   });
 
   describe('action saves the cache', () => {

__tests__/find-pypy.test.ts

@@ -17,7 +17,7 @@ import {
   getPyPyVersionFromPath
 } from '../src/utils';
 
-const manifestData = require('./data/pypy.json');
+import manifestData from './data/pypy.json';
 
 let architecture: string;
 
@@ -51,7 +51,7 @@ describe('parsePyPyVersion', () => {
   it.each(['', 'pypy-', 'pypy', 'p', 'notpypy-'])(
     'throw on invalid input "%s"',
     input => {
-      expect(() => finder.parsePyPyVersion(input)).toThrowError(
+      expect(() => finder.parsePyPyVersion(input)).toThrow(
         "Invalid 'version' property for PyPy. PyPy version should be specified as 'pypy<python-version>' or 'pypy-<python-version>'. See README for examples and documentation."
       );
     }
@@ -60,7 +60,7 @@ describe('parsePyPyVersion', () => {
   it.each(['pypy-2', 'pypy-3', 'pypy2', 'pypy3', 'pypy3.x', 'pypy3.8.10'])(
     'throw on invalid input "%s"',
     input => {
-      expect(() => finder.parsePyPyVersion(input)).toThrowError(
+      expect(() => finder.parsePyPyVersion(input)).toThrow(
         "Invalid format of Python version for PyPy. Python version should be specified in format 'x.y'. See README for examples and documentation."
       );
     }
@@ -369,7 +369,7 @@ describe('findPyPyVersion', () => {
         false,
         false
       )
-    ).rejects.toThrowError(
+    ).rejects.toThrow(
       `PyPy version 3.7 (v7.5.x) with arch ${architecture} not found`
     );
   });
@@ -453,7 +453,7 @@ describe('findPyPyVersion', () => {
     spyChmodSync.mockImplementation(() => undefined);
     await expect(
       finder.findPyPyVersion('pypy3.8', architecture, false, false, false)
-    ).rejects.toThrowError();
+    ).rejects.toThrow();
     await expect(
       finder.findPyPyVersion('pypy3.8', architecture, false, false, true)
     ).resolves.toEqual({

__tests__/finder.test.ts

@@ -24,7 +24,7 @@ import * as core from '@actions/core';
 import * as finder from '../src/find-python';
 import * as installer from '../src/install-python';
 
-const manifestData = require('./data/versions-manifest.json');
+import manifestData from './data/versions-manifest.json';
 
 describe('Finder tests', () => {
   let writeSpy: jest.SpyInstance;
@@ -192,7 +192,7 @@ describe('Finder tests', () => {
     expect(infoSpy).toHaveBeenCalledWith(
       'Version 1.2.3 was not found in the local cache'
     );
-    expect(infoSpy).toBeCalledWith(
+    expect(infoSpy).toHaveBeenCalledWith(
       'Version 1.2.3 is available for downloading'
     );
     expect(installSpy).toHaveBeenCalled();
@@ -252,7 +252,7 @@ describe('Finder tests', () => {
     // This will throw if it doesn't find it in the cache and in the manifest (because no such version exists)
     await expect(
       finder.useCpythonVersion('1.1', 'x64', false, false, false)
-    ).rejects.toThrowError();
+    ).rejects.toThrow();
     await expect(
       finder.useCpythonVersion('1.1', 'x64', false, false, true)
     ).resolves.toEqual({
@@ -262,7 +262,7 @@ describe('Finder tests', () => {
     // Check 1.1.0 version specifier does not fallback to '1.1.0-beta.2'
     await expect(
       finder.useCpythonVersion('1.1.0', 'x64', false, false, true)
-    ).rejects.toThrowError();
+    ).rejects.toThrow();
   });
 
   it('Errors if Python is not installed', async () => {

__tests__/install-pypy.test.ts

@@ -14,7 +14,7 @@ import {
   IS_WINDOWS
 } from '../src/utils';
 
-const manifestData = require('./data/pypy.json');
+import manifestData from './data/pypy.json';
 
 let architecture: string;
 if (IS_WINDOWS) {
@@ -294,7 +294,7 @@ describe('installPyPy', () => {
   it('throw if release is not found', async () => {
     await expect(
       installer.installPyPy('7.3.3', '3.6.17', architecture, false, undefined)
-    ).rejects.toThrowError(
+    ).rejects.toThrow(
       `PyPy version 3.6.17 (7.3.3) with arch ${architecture} not found`
     );
 
@@ -338,7 +338,7 @@ describe('installPyPy', () => {
 
     await expect(
       installer.installPyPy('7.4.x', '3.6.12', architecture, false, undefined)
-    ).rejects.toThrowError();
+    ).rejects.toThrow();
     await expect(
       installer.installPyPy('7.4.x', '3.6.12', architecture, true, undefined)
     ).resolves.toEqual({

dist/cache-save/index.js

@@ -59757,8 +59757,7 @@ exports["default"] = CacheDistributor;
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.CACHE_DEPENDENCY_BACKUP_PATH = void 0;
-const CACHE_DEPENDENCY_BACKUP_PATH = '**/pyproject.toml';
+exports.CACHE_DEPENDENCY_BACKUP_PATH = '**/pyproject.toml';
-exports.CACHE_DEPENDENCY_BACKUP_PATH = CACHE_DEPENDENCY_BACKUP_PATH;
 
 
 /***/ }),

docs/contributors.md

@@ -60,6 +60,7 @@ Pull requests are the easiest way to contribute changes to git repos at GitHub.
 
 - To implement new features or fix bugs, you need to make changes to the `.ts` files, which are located in the `src` folder
 - To comply with the code style, **you need to run the `format` script**
+- To lint the code, **you need to run the `lint:fix` script**
 - To transpile source code to `javascript` we use [NCC](https://github.com/vercel/ncc). **It is very important to run the `build` script after making changes**, otherwise your changes will not get into the final `javascript` build
 
 **Learn more about how to implement tests:**

package.json

@@ -6,9 +6,10 @@
   "main": "dist/index.js",
   "scripts": {
     "build": "ncc build -o dist/setup src/setup-python.ts && ncc build -o dist/cache-save src/cache-save.ts",
-    "format": "prettier --write \"{,!(node_modules)/**/}*.ts\"",
+    "format": "prettier --no-error-on-unmatched-pattern --config ./.prettierrc.js --write **/*.{ts,yml,yaml}",
-    "format-check": "prettier --check \"{,!(node_modules)/**/}*.ts\"",
+    "format-check": "prettier --no-error-on-unmatched-pattern --config ./.prettierrc.js --check **/*.{ts,yml,yaml}",
-    "lint": "echo \"Fake command that does nothing. It is used in reusable workflows\"",
+    "lint": "eslint --config ./.eslintrc.js **/*.ts",
+    "lint:fix": "eslint --config ./.eslintrc.js **/*.ts --fix",
     "release": "ncc build -o dist/setup src/setup-python.ts && ncc build -o dist/cache-save src/cache-save.ts && git add -f dist/",
     "test": "jest --coverage"
   },
@@ -36,11 +37,16 @@
     "@types/jest": "^27.0.2",
     "@types/node": "^16.11.25",
     "@types/semver": "^7.1.0",
+    "@typescript-eslint/eslint-plugin": "^5.54.0",
+    "@typescript-eslint/parser": "^5.54.0",
     "@vercel/ncc": "^0.33.4",
+    "eslint": "^8.35.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-jest": "^27.2.1",
     "husky": "^7.0.2",
     "jest": "^27.2.5",
     "jest-circus": "^27.2.5",
-    "prettier": "^2.0.2",
+    "prettier": "^2.8.4",
     "ts-jest": "^27.0.5",
     "typescript": "^4.2.3"
   },

src/cache-distributions/constants.ts

@@ -1,2 +1 @@
-const CACHE_DEPENDENCY_BACKUP_PATH: string = '**/pyproject.toml';
+export const CACHE_DEPENDENCY_BACKUP_PATH = '**/pyproject.toml';
-export {CACHE_DEPENDENCY_BACKUP_PATH};

src/cache-distributions/pip-cache.ts

@@ -15,7 +15,7 @@ class PipCache extends CacheDistributor {
 
   constructor(
     private pythonVersion: string,
-    cacheDependencyPath: string = '**/requirements.txt'
+    cacheDependencyPath = '**/requirements.txt'
   ) {
     super('pip', cacheDependencyPath);
   }

src/find-pypy.ts

@@ -65,11 +65,8 @@ export async function findPyPyVersion(
   ));
 
   if (!installDir) {
-    ({
+    ({installDir, resolvedPythonVersion, resolvedPyPyVersion} =
-      installDir,
+      await pypyInstall.installPyPy(
-      resolvedPythonVersion,
-      resolvedPyPyVersion
-    } = await pypyInstall.installPyPy(
         pypyVersionSpec.pypyVersion,
         pypyVersionSpec.pythonVersion,
         architecture,
@@ -145,7 +142,7 @@ export function parsePyPyVersion(versionSpec: string): IPyPyVersionSpec {
   const versions = versionSpec.split('-').filter(item => !!item);
 
   if (/^(pypy)(.+)/.test(versions[0])) {
-    let pythonVersion = versions[0].replace('pypy', '');
+    const pythonVersion = versions[0].replace('pypy', '');
     versions.splice(0, 1, 'pypy', pythonVersion);
   }
 

src/install-pypy.ts

@@ -63,7 +63,7 @@ export async function installPyPy(
   }
 
   const {foundAsset, resolvedPythonVersion, resolvedPyPyVersion} = releaseData;
-  let downloadUrl = `${foundAsset.download_url}`;
+  const downloadUrl = `${foundAsset.download_url}`;
 
   core.info(`Downloading PyPy from "${downloadUrl}" ...`);
 
@@ -143,7 +143,7 @@ async function createPyPySymlink(
   const pythonMinor = semver.minor(version);
   const pypyBinaryPostfix = pythonBinaryPostfix === 2 ? '' : '3';
   const pypyMajorMinorBinaryPostfix = `${pythonBinaryPostfix}.${pythonMinor}`;
-  let binaryExtension = IS_WINDOWS ? '.exe' : '';
+  const binaryExtension = IS_WINDOWS ? '.exe' : '';
 
   core.info('Creating symlinks...');
   createSymlinkInFolder(

src/setup-python.ts

@@ -23,7 +23,7 @@ async function cacheDependencies(cache: string, pythonVersion: string) {
 }
 
 function resolveVersionInput() {
-  let versions = core.getMultilineInput('python-version');
+  const versions = core.getMultilineInput('python-version');
   let versionFile = core.getInput('python-version-file');
 
   if (versions.length && versionFile) {

src/utils.ts

@@ -1,3 +1,4 @@
+/* eslint no-unsafe-finally: "off" */
 import * as cache from '@actions/cache';
 import * as core from '@actions/core';
 import fs from 'fs';
@@ -71,7 +72,7 @@ export function getPyPyVersionFromPath(installDir: string) {
  */
 export function readExactPyPyVersionFile(installDir: string) {
   let pypyVersion = '';
-  let fileVersion = path.join(installDir, PYPY_VERSION_FILE);
+  const fileVersion = path.join(installDir, PYPY_VERSION_FILE);
   if (fs.existsSync(fileVersion)) {
     pypyVersion = fs.readFileSync(fileVersion).toString().trim();
   }

tsconfig.json

@@ -45,7 +45,8 @@
     // "typeRoots": [],                       /* List of folders to include type definitions from. */
     // "types": [],                           /* Type declaration files to be included in compilation. */
     // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    "esModuleInterop": true,                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    "resolveJsonModule": true,                /* Allows importing modules with a '.json' extension, which is a common practice in node projects. */
     // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
     // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
 

yaml-lint-config.yml

@@ -1,7 +0,0 @@
-extends: default
-
-rules:
-  # 120 chars should be enough, but don't fail if a line is longer
-  line-length:
-    max: 120
-    level: warning