Merge pull request #21 from faissaloux/settings

Allow user to enable/disable package managers

Author: faissaloux

package.json

@@ -75,5 +75,39 @@
     "@faissaloux/gemfile": "^0.3.0",
     "@yarnpkg/lockfile": "^1.1.0",
     "js-yaml": "^4.1.0"
+  },
+  "contributes": {
+    "configuration": [
+      {
+        "title": "package-manager-intellisense",
+        "properties": {
+            "package-manager-intellisense.npm.enable": {
+                "type": "boolean",
+                "default": true,
+                "description": "Enable npm package manager."
+            },
+            "package-manager-intellisense.yarn.enable": {
+                "type": "boolean",
+                "default": true,
+                "description": "Enable yarn package manager."
+            },
+            "package-manager-intellisense.pnpm.enable": {
+                "type": "boolean",
+                "default": true,
+                "description": "Enable pnpm package manager."
+            },
+            "package-manager-intellisense.composer.enable": {
+                "type": "boolean",
+                "default": true,
+                "description": "Enable composer package manager."
+            },
+            "package-manager-intellisense.bundler.enable": {
+                "type": "boolean",
+                "default": true,
+                "description": "Enable bundler package manager."
+            }
+        }
+      }
+    ]
   }
 }

src/decorator/decorator.ts

@@ -57,7 +57,9 @@ export class Decorator {
                     version = `v${installedPackage?.version.replace('v', '')}`;
                 }
 
-                decorations.push(this.decoration(version, line));
+                if (installedPackage !== null) {
+                    decorations.push(this.decoration(version, line));
+                }
             }
         }
 

src/extension.ts

@@ -1,13 +1,21 @@
 import * as vscode from 'vscode';
 import * as globals from './util/globals';
 import { Decorator } from './decorator/decorator';
-import { PackageManager } from './package_manager/package_manager';
+import { DependenciesFile, PackageManager } from './package_manager/package_manager';
 
 function supportedOpenEditors(): vscode.TextEditor[] {
+	const packagesFiles: DependenciesFile[] = ['package.json'];
+
+	if (vscode.workspace.getConfiguration().get('package-manager-intellisense.composer.enable')) {
+		packagesFiles.push('composer.json');
+	}
+
+	if (vscode.workspace.getConfiguration().get('package-manager-intellisense.bundler.enable')) {
+		packagesFiles.push('Gemfile');
+	}
+
 	return vscode.window.visibleTextEditors.filter(
-		editor => editor.document.fileName.endsWith('package.json')
-			|| editor.document.fileName.endsWith('composer.json')
-			|| editor.document.fileName.endsWith('Gemfile')
+		editor => globals.endsWithAny(packagesFiles, editor.document.fileName)
 	);
 }
 

src/package_manager/package_manager.ts

@@ -3,16 +3,20 @@ import { Javascript } from './package_managers/javascript';
 import { Php } from './package_managers/php';
 import { Ruby } from './package_managers/ruby';
 import path = require('path');
+import { LanguagePackageManager } from './language_package_manager';
+
+type Language = 'php' | 'javascript' | 'ruby';
+export type DependenciesFile = 'composer.json' | 'package.json' | 'Gemfile';
 
 export class PackageManager {
     private editorFileName: string;
     private packageManager: string = '';
-    private languagesPackagesFiles: {[key: string]: string} = {
+    private languagesPackagesFiles: {[key in Language]: DependenciesFile} = {
         'php': 'composer.json',
         'javascript': 'package.json',
         'ruby': 'Gemfile',
     };
-    private packageManagers = {
+    private packageManagers: {[key in Language]: typeof LanguagePackageManager} = {
         'php': Php,
         'javascript': Javascript,
         'ruby': Ruby,

src/package_manager/package_managers/javascript.ts

@@ -4,14 +4,17 @@ import { PackageManager } from '../../interfaces/package_manager';
 import { LanguagePackageManager } from '../language_package_manager';
 import { pathJoin } from '../../util/globals';
 
+type JavascriptPackageManager = 'npm' | 'yarn' | 'pnpm';
+type JavascriptDependenciesLockFile = 'package-lock.json' | 'yarn.lock' | 'pnpm-lock.yaml';
+
 export class Javascript extends LanguagePackageManager implements PackageManager {
-    packageManager: string = 'npm';
-    locks: {[key: string]: string} = {
+    packageManager: JavascriptPackageManager = 'npm';
+    locks: {[key in JavascriptPackageManager]: JavascriptDependenciesLockFile} = {
         'npm': 'package-lock.json',
         'yarn': 'yarn.lock',
         'pnpm': 'pnpm-lock.yaml',
     };
-    startsWith: {[key: string]: string} = {
+    startsWith: {[key in JavascriptPackageManager]: string} = {
         'npm': 'packageName',
         'yarn': 'packageName@',
         'pnpm': '/packageName/',
@@ -21,6 +24,10 @@ export class Javascript extends LanguagePackageManager implements PackageManager
         this.packageManager = await this.getPackageManager();
         const installedPackages = new Parser(this.packageManager).parse(await this.lockFileContent());
 
+        if (!vscode.workspace.getConfiguration().get(`package-manager-intellisense.${this.packageManager}.enable`)) {
+            return null;
+        }
+
         if (this.packageManager === 'pnpm') {
             this.appendVersion(installedPackages);
         }
@@ -32,18 +39,18 @@ export class Javascript extends LanguagePackageManager implements PackageManager
         return pathJoin(this.rootPath, this.locks[this.packageManager]);
     }
 
-    async getPackageManager(): Promise<string> {
+    async getPackageManager(): Promise<JavascriptPackageManager> {
         for (const lock in this.locks) {
-            let lockFile = vscode.Uri.file(pathJoin(this.rootPath, this.locks[lock]));
+            let lockFile = vscode.Uri.file(pathJoin(this.rootPath, this.locks[lock as JavascriptPackageManager]));
 
             try{
                 await vscode.workspace.fs.readFile(lockFile);
 
-                return lock;
+                return lock as JavascriptPackageManager;
             } catch (error) {}
         }
 
-        return Object.keys(this.locks)[0];
+        return (Object.keys(this.locks) as JavascriptPackageManager[])[0];
     }
 
     lockPackageStartsWith(packageName: string): string {

src/util/globals.ts

@@ -6,3 +6,5 @@ export const decorationType = vscode.window.createTextEditorDecorationType({
 });
 
 export const pathJoin = (...parts: string[]): string => parts.join(path.sep);
+
+export const endsWithAny = (options: string[], string: string): boolean => options.some((option: string) => string.endsWith(option));