merge master

Author: ricardo-devis-agullo

src/cli/commands.ts

@@ -52,6 +52,11 @@ export default {
           boolean: false,
           description: 'Url prefix for registry server',
           default: ''
+        },
+        components: {
+          array: true,
+          description:
+            'List of component names that you want to be packaged and exposed on dev registry'
         }
       },
       usage: 'Usage: $0 dev <dirPath> [port] [baseUrl] [options]'

src/cli/domain/get-components-by-dir.ts

@@ -3,7 +3,10 @@ import path from 'path';
 import { Component } from '../../types';
 
 export default function getComponentsByDir() {
-  return async (componentsDir: string): Promise<string[]> => {
+  return async (
+    componentsDir: string,
+    componentsToRun?: string[]
+  ): Promise<string[]> => {
     const isOcComponent = (file: string) => {
       const filePath = path.resolve(componentsDir, file);
       const packagePath = path.join(filePath, 'package.json');
@@ -25,7 +28,12 @@ export default function getComponentsByDir() {
     };
 
     try {
-      const dirContent = await fs.readdir(componentsDir);
+      let dirContent = await fs.readdir(componentsDir);
+      if (componentsToRun) {
+        dirContent = dirContent.filter(content =>
+          componentsToRun.includes(content)
+        );
+      }
 
       const components = dirContent
         .filter(isOcComponent)

src/cli/facade/dev.ts

@@ -31,6 +31,7 @@ const dev = ({ local, logger }: { logger: Logger; local: Local }) =>
       baseUrl: string;
       fallbackRegistryUrl: string;
       hotReloading?: boolean;
+      components?: string[];
       watch?: boolean;
       verbose?: boolean;
       production?: boolean;
@@ -120,7 +121,10 @@ const dev = ({ local, logger }: { logger: Logger; local: Local }) =>
       };
 
       logger.warn(cliMessages.SCANNING_COMPONENTS, true);
-      const components = await local.getComponentsByDir(componentsDir);
+      const components = await local.getComponentsByDir(
+        componentsDir,
+        opts.components
+      );
 
       if (_.isEmpty(components)) {
         const err = cliErrors.DEV_FAIL(cliErrors.COMPONENTS_NOT_FOUND);
@@ -170,6 +174,7 @@ const dev = ({ local, logger }: { logger: Logger; local: Local }) =>
         hotReloading,
         liveReloadPort: liveReload.port,
         local: true,
+        components: opts.components,
         path: path.resolve(componentsDir),
         port,
         templates: dependencies.templates,

src/registry/domain/repository.ts

@@ -55,16 +55,18 @@ export default function repository(conf: Config): Repository {
         .toString();
     },
     getComponents(): string[] {
-      const validComponents = fs.readdirSync(conf.path).filter(file => {
-        const isDir = fs.lstatSync(path.join(conf.path, file)).isDirectory();
-        const isValidComponent = isDir
-          ? fs
-              .readdirSync(path.join(conf.path, file))
-              .filter(file => file === '_package').length === 1
-          : false;
-
-        return isValidComponent;
-      });
+      const validComponents =
+        conf.components ||
+        fs.readdirSync(conf.path).filter(file => {
+          const isDir = fs.lstatSync(path.join(conf.path, file)).isDirectory();
+          const isValidComponent = isDir
+            ? fs
+                .readdirSync(path.join(conf.path, file))
+                .filter(file => file === '_package').length === 1
+            : false;
+
+          return isValidComponent;
+        });
 
       validComponents.push('oc-client');
       return validComponents;

src/types.ts

@@ -127,6 +127,7 @@ export interface Config {
   hotReloading: boolean;
   keepAliveTimeout?: number;
   liveReloadPort: number;
+  components?: string[];
   local: boolean;
   path: string;
   plugins: Record<string, (...args: unknown[]) => void>;
@@ -234,7 +235,10 @@ export interface Local {
   };
   cleanup: (compressedPackagePath: string) => Promise<void>;
   compress: (input: string, output: string) => Promise<void>;
-  getComponentsByDir: (componentsDir: string) => Promise<string[]>;
+  getComponentsByDir: (
+    componentsDir: string,
+    componentsToRun?: string[]
+  ) => Promise<string[]>;
   init: (options: {
     componentName: string;
     logger: Logger;

test/unit/cli-domain-get-components-by-dir.js

@@ -34,8 +34,8 @@ const initialise = function () {
   return { local: local, fs: fsMock };
 };
 
-const executeComponentsListingByDir = function (local) {
-  return local('.');
+const executeComponentsListingByDir = function (local, componentsToRun) {
+  return local('.', componentsToRun);
 };
 
 describe('cli : domain : get-components-by-dir', () => {
@@ -140,4 +140,43 @@ describe('cli : domain : get-components-by-dir', () => {
       expect(result).to.eql([]);
     });
   });
+
+  describe('when components are filtered', () => {
+    let error;
+    let result;
+    beforeEach(done => {
+      const data = initialise();
+
+      data.fs.readdir
+        .onCall(0)
+        .resolves([
+          'component1',
+          'component2',
+          'component3',
+          'component4',
+          'package.json'
+        ]);
+
+      data.fs.readJsonSync.onCall(0).returns({ oc: {} });
+      data.fs.readJsonSync.onCall(1).returns({ oc: {} });
+      data.fs.readJsonSync.onCall(2).returns({ oc: {} });
+      data.fs.readJsonSync.onCall(3).returns({ oc: {} });
+      data.fs.readJsonSync
+        .onCall(4)
+        .throws(new Error('ENOENT: no such file or directory'));
+
+      executeComponentsListingByDir(data.local, ['component1', 'component3'])
+        .then(res => (result = res))
+        .catch(err => (error = err))
+        .finally(done);
+    });
+
+    it('should not error', () => {
+      expect(error).to.be.undefined;
+    });
+
+    it('should get an the filtered list', () => {
+      expect(result).to.eql(['./component1', './component3']);
+    });
+  });
 });