feat: extract package name and se for ComponentSource

ccontrols · Mar 16, 2020 · 71d6f13 · 71d6f13
1 parent 5452a1b
commit 71d6f13
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 5 deletions.
diff --git a/core/instrument/src/misc/packageInfo.ts b/core/instrument/src/misc/packageInfo.ts
@@ -100,7 +100,12 @@ export const packageInfo = async (
             .replace('{committish}', templates.committish || 'master');
         };
         const result: Repository = {};
-        const { storeBrowseLink, storeDocsLink, storeIssuesLink } = opts || {};
+        const {
+          storeBrowseLink,
+          storeDocsLink,
+          storeIssuesLink,
+          storePackageName,
+        } = opts || {};
         if (storeBrowseLink) {
           result.browse = fillTemplate(templates.browsefiletemplate);
         }
@@ -110,6 +115,9 @@ export const packageInfo = async (
         if (storeIssuesLink) {
           result.issues = fillTemplate(templates.bugstemplate);
         }
+        if (storePackageName) {
+          result.name = packageJSON.name;
+        }
         return result;
       }
     }

diff --git a/core/instrument/src/types.ts b/core/instrument/src/types.ts
@@ -80,6 +80,7 @@ export const defaultPackageOptions: PackageInfoOptions = {
   storeBrowseLink: true,
   storeDocsLink: true,
   storeIssuesLink: true,
+  storePackageName: true,
 };
 
 export const defaultComponentOptions: ComponentOptions = {
@@ -106,6 +107,11 @@ export interface PackageInfoOptions {
    */
   packageJsonName?: string;
 
+  /**
+   * Whether to save the package name in the repository field
+   */
+  storePackageName?: boolean;
+
   /**
    * Whether to save the link for browsing the file in the repository field
    */

diff --git a/core/specification/src/utility.ts b/core/specification/src/utility.ts
@@ -23,6 +23,10 @@ export interface CodeLocation {
  *
  */
 export interface Repository {
+  /**
+   * package name
+   */
+  name?: string;
   /**
    * link for browsing the file
    */

diff --git a/ui/blocks/src/ComponentSource/ComponentSource.tsx b/ui/blocks/src/ComponentSource/ComponentSource.tsx
@@ -19,12 +19,14 @@ export const ComponentSource: FC<ComponentSourceProps> = ({
     of,
   });
   let source;
-  const { from, importedName, name: componentName } = component || {};
-  if (from) {
+  const { from, importedName, name: componentName, repository } =
+    component || {};
+  const importFrom = repository && repository.name ? repository.name : from;
+  if (importFrom) {
     source =
       importedName !== 'default' && importedName !== 'namespace'
-        ? `import { ${componentName} } from '${from}';`
-        : `import ${componentName} from '${from}';`;
+        ? `import { ${componentName} } from '${importFrom}';`
+        : `import ${componentName} from '${importFrom}';`;
   }
 
   if (!source) {