feat(plugins): add support for plugins shortcuts

bin/pluginsLoader.ts

@@ -2,6 +2,7 @@ import Debug from 'debug';
 import path from 'path';
 import { ExportPluginCtor, ExportPluginModule } from '../lib/types';
 import { Utils } from '../lib/utils';
+import { plugins } from '../lib';
 
 const info = Debug('sol-merger:info');
 const error = Debug('sol-merger:error');
@@ -24,6 +25,11 @@ export class PluginsLoader {
   async getPlugins(): Promise<ExportPluginCtor[]> {
     const result: ExportPluginCtor[] = [];
     for (const pluginPath of this.#pluginPaths) {
+      const defaultPlugin = plugins[pluginPath];
+      if (defaultPlugin) {
+        result.push(defaultPlugin);
+        continue;
+      }
       const fullPluginPath = this.getPluginPath(pluginPath);
       if (!fullPluginPath) {
         continue;

lib/index.ts

@@ -15,6 +15,8 @@ const merge = async (file: string, options: SolMergerOptions = {}) => {
 };
 
 export * from './antlr/visitors/types';
+export { plugins } from './plugins';
+
 export {
   Merger,
   FileAnalyzer,

lib/plugins/index.ts

@@ -0,0 +1,6 @@
+import { ExportPluginCtor } from '../types';
+import { ExportPlugin as SPDXLicenseRemovePlugin } from './SPDXLicenseRemovePlugin';
+
+export const plugins: Record<string, ExportPluginCtor | undefined> = {
+  SPDXLicenseRemovePlugin,
+};

package.json

@@ -15,7 +15,7 @@
   },
   "scripts": {
     "test": "mocha",
-    "build": "tsc --newLine lf -p tsconfig.app.json",
+    "build": "rm -r dist || true && tsc --newLine lf -p tsconfig.app.json",
     "lint": "tslint -p tsconfig.app.json",
     "antlr4ts": "antlr4ts -visitor Solidity.g4",
     "changelog": "npx conventional-changelog-cli -p angular -i CHANGELOG.md -s -r 0"

test-cli.sh

@@ -46,6 +46,11 @@ sol-merger --export-plugin ./dist/lib/plugins/SPDXLicenseRemovePlugin.js "test/c
 
 compareFile compiled/LocalImportsWithSPDX.sol
 
+rm -rf compiled
+sol-merger --export-plugin SPDXLicenseRemovePlugin "test/contracts/*.sol" compiled
+
+compareFile compiled/LocalImportsWithSPDX.sol
+
 # Remove Comments
 echo "Compilation with --remove-comments option"
 rm -rf compiled

test/index.spec.ts

@@ -1,7 +1,7 @@
 import { assert } from 'chai';
 import path from 'path';
 import { merge, Merger } from '../lib/index';
-import { SPDXLicenseRemovePlugin } from '../lib/plugins';
+import { plugins } from '../lib/plugins';
 import { assertWithFile, testFile } from './utils';
 
 describe('Solidity Merger', () => {
@@ -93,8 +93,12 @@ describe('Solidity Merger', () => {
   });
 
   it('should compile use plugins correctly', async () => {
+    if (!plugins.SPDXLicenseRemovePlugin) {
+      assert.fail('SPDXLicenseRemovePlugin is not defined');
+      return;
+    }
     await testFile('LocalImportsWithSPDX', {
-      exportPlugins: [SPDXLicenseRemovePlugin],
+      exportPlugins: [plugins.SPDXLicenseRemovePlugin],
     });
   });