Merge pull request #7 from tiktok/chao/add-eslint

feat: add eslint

packages/pnpm-sync-lib/.eslintrc.js

@@ -0,0 +1,5 @@
+require("@rushstack/eslint-patch/modern-module-resolution");
+module.exports = {
+  extends: ['@rushstack/eslint-config/profile/node'],
+  parserOptions: { tsconfigRootDir: __dirname }
+};

packages/pnpm-sync-lib/package.json

@@ -13,6 +13,7 @@
   "scripts": {
     "build": "heft build --clean",
     "test": "heft test --clean",
+    "lint": "eslint src/**",
     "prepublishOnly": "heft build --clean"
   },
   "dependencies": {
@@ -23,6 +24,7 @@
   },
   "devDependencies": {
     "@rushstack/eslint-config": "^3.6.2",
+    "@rushstack/eslint-patch": "^1.7.2",
     "@rushstack/heft": "^0.64.3",
     "@rushstack/heft-node-rig": "^2.4.5",
     "@types/heft-jest": "1.0.6",

packages/pnpm-sync-lib/src/interfaces.ts

@@ -1,17 +1,17 @@
-export interface PnpmSyncCliArgs {
+export interface IPnpmSyncCliArgs {
   prepare: boolean,
   lockfile: string,
   store: string
 } 
 
-export interface PnpmSyncJson {
+export interface IPnpmSyncJson {
   postbuildInjectedCopy: {
     sourceFolder: string,
-    targetFolders: Array<TargetFolder>
+    targetFolders: Array<ITargetFolder>
   }
 }
 
-export interface TargetFolder {
+export interface ITargetFolder {
   folderPath: string
 }
 

packages/pnpm-sync-lib/src/pnpmSyncPrepare.ts

@@ -1,4 +1,4 @@
-import { PnpmSyncJson } from "./interfaces";
+import { IPnpmSyncJson } from "./interfaces";
 import {
   readWantedLockfile,
   type Lockfile,
@@ -98,7 +98,7 @@ export async function pnpmSyncPrepare(
 
     const pnpmSyncJsonPath = `${projectFolder}/node_modules/.pnpm-sync.json`;
 
-    let pnpmSyncJsonFile: PnpmSyncJson = {
+    let pnpmSyncJsonFile: IPnpmSyncJson = {
       postbuildInjectedCopy: {
         sourceFolder: "../..",
         targetFolders: [],
@@ -167,15 +167,15 @@ function transferFilePathToPnpmStorePath(
 
 // process dependencies and devDependencies to generate injectedDependencyToFilePath
 function getInjectedDependencyToVersion(
+  // eslint-disable-next-line @rushstack/no-new-null
   pnpmLockfile: Lockfile | null
 ): Map<string, Set<string>> {
   const injectedDependencyToVersion: Map<string, Set<string>> = new Map();
   for (const importerKey in pnpmLockfile?.importers) {
-    const dependenciesMeta =
-      pnpmLockfile?.importers[importerKey]?.dependenciesMeta;
-    if (!dependenciesMeta) {
+    if (!pnpmLockfile?.importers[importerKey]?.dependenciesMeta){
       continue;
     }
+    const dependenciesMeta = pnpmLockfile?.importers[importerKey]?.dependenciesMeta;
 
     for (const dependency in dependenciesMeta) {
       if (dependenciesMeta[dependency]?.injected) {
@@ -200,13 +200,12 @@ function getInjectedDependencyToVersion(
       injectedDependencyToVersion
     );
   }
-
   return injectedDependencyToVersion;
 }
 function processDependencies(
   dependencies: Dependencies | undefined,
   injectedDependencyToVersion: Map<string, Set<string>>
-) {
+): void {
   if (dependencies) {
     for (const dependency in dependencies) {
       if (injectedDependencyToVersion.has(dependency)) {

packages/pnpm-sync/.eslintrc.js

@@ -0,0 +1,5 @@
+require("@rushstack/eslint-patch/modern-module-resolution");
+module.exports = {
+  extends: ['@rushstack/eslint-config/profile/node'],
+  parserOptions: { tsconfigRootDir: __dirname }
+};

packages/pnpm-sync/package.json

@@ -30,6 +30,7 @@
   "scripts": {
     "build": "heft build --clean",
     "test": "heft test --clean",
+    "lint": "eslint src/**",
     "prepublishOnly": "heft build --clean"
   },
   "bin": {
@@ -42,6 +43,7 @@
   "devDependencies": {
     "@rushstack/eslint-config": "^3.6.2",
     "@rushstack/heft": "^0.64.3",
+    "@rushstack/eslint-patch": "^1.7.2",
     "@rushstack/heft-node-rig": "^2.4.5",
     "@types/heft-jest": "1.0.6",
     "@types/node": "18.17.15",

packages/pnpm-sync/src/start.ts

@@ -1,7 +1,7 @@
 import { Command } from 'commander';
 import { pnpmSyncCopy, pnpmSyncPrepare } from 'pnpm-sync-lib';
 
-const program = new Command();
+const program:Command = new Command();
 
 program.version(require('../package.json').version);
 
@@ -13,10 +13,10 @@ program.command('prepare')
   .description('Generate the pnpm-sync.json based on pnpm-lock.yaml file path and .pnpm folder path')
   .requiredOption('-l, --lockfile <value>', 'The pnpm-lock.yaml file path')
   .requiredOption('-s, --store <value>', 'The .pnpm folder path')
-  .action(options => {
+  .action(async options => {
     const { lockfile, store } = options;
     try {
-      pnpmSyncPrepare(lockfile, store);
+      await pnpmSyncPrepare(lockfile, store);
     } catch (error) {
       console.log(error);
     }