feat: automatically get the package name and description

ccontrols · Mar 23, 2020 · e335483 · e335483
1 parent 0a24d85
commit e335483
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -13,9 +13,10 @@
 
 <!-- START-PACKAGE-SECTION -->
 
-## @component-controls/instrument
+## [@component-controls/instrument](https://github.com/ccontrols/component-controls/blob/master/core/instrument)
+
+Component controls instrumentation library
 
-Component controls instrumentation library. 
 Parsing a source file will generate the following information:
 
 -   CSF: List of story named exports
@@ -39,9 +40,9 @@ Parsing a source file will generate the following information:
 
 <!-- START-PACKAGE-SECTION -->
 
-## @component-controls/components
+## [@component-controls/components](https://github.com/ccontrols/component-controls/blob/master/ui/components)
 
-A collection of commonly used UI components for component-controls
+Component controls commonly used UI components.
 
 Some of the guiding design goals for this library:
 
@@ -67,9 +68,9 @@ Third-libraries used in no particular order:
 
 <!-- START-PACKAGE-SECTION -->
 
-## @component-controls/editors
+## [@component-controls/editors](https://github.com/ccontrols/component-controls/blob/master/core/specification)
 
-A collection of editors used to edit component control values.
+Component controls editors for component control values.
 
 Some of the guiding design goals for this library:
 
@@ -82,9 +83,9 @@ Some of the guiding design goals for this library:
 
 <!-- START-PACKAGE-SECTION -->
 
-## @component-controls/blocks
+## [@component-controls/blocks](https://github.com/ccontrols/component-controls/blob/master/ui/blocks)
 
-A collection of core block components - intended to be displayed on the documentation page of stories.
+Component controls core documentation blocks.
 
 Some of the guiding design goals for this library:
 

diff --git a/core/instrument/README.md b/core/instrument/README.md
@@ -1,8 +1,5 @@
 # Overview 
 
-## @component-controls/instrument
-
-Component controls instrumentation library. 
 Parsing a source file will generate the following information:
 - CSF: List of story named exports
 - CSF: Default export stories file information

diff --git a/scripts/insert-overview.js b/scripts/insert-overview.js
@@ -1,4 +1,5 @@
 const fs = require('fs');
+const path = require('path');
 const remark = require('remark');
 const { extractCustomTag, inlineNewContent } = require('./utils');
 
@@ -15,6 +16,29 @@ function insertOverview(options) {
       const sectionName = sectionAttr ? sectionAttr[1].toLowerCase() : 'overview';
       const content = fs.readFileSync(file[1], 'utf8');
       const overviewNodes = [];
+      const packageJSONFilename = path.resolve(path.join(path.dirname(file[1]), 'package.json'));
+      if (fs.existsSync(packageJSONFilename)) {
+        const packageJSON = JSON.parse(fs.readFileSync(packageJSONFilename));
+
+        const { name, description, repository: { directory }} = packageJSON;
+        const rootRepoDir = `https://github.com/ccontrols/component-controls/blob/master/${directory}`;
+        overviewNodes.push({
+          type: 'heading',
+          depth: 2,
+          children: [
+            { type: 'link', url: rootRepoDir, children: [
+              { type: 'text', value: name}
+            ]}
+          ]
+        });
+        overviewNodes.push({
+          type: 'paragraph',
+          children: [
+              { type: 'text', value: description}
+          ]
+        });
+
+      }
       remark()
         .use(() => sectionNode => {
           let foundDepth = 0;

diff --git a/ui/blocks/README.md b/ui/blocks/README.md
@@ -19,10 +19,6 @@
 
 # Overview
 
-## @component-controls/blocks
-
-A collection of core block components - intended to be displayed on the documentation page of stories.
-
 Some of the guiding design goals for this library:
 
 -   Most components should have a 'plain' and a 'block' version, where the block version adds a collapsible Box with a title.

diff --git a/ui/blocks/package.json b/ui/blocks/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@component-controls/blocks",
   "version": "0.6.0",
-  "description": "Core blocks component controls",
+  "description": "Component controls core documentation blocks.",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
   "typings": "dist/index.d.ts",

diff --git a/ui/components/README.md b/ui/components/README.md
@@ -24,9 +24,6 @@
 
 # Overview
 
-## @component-controls/components
-
-A collection of commonly used UI components for component-controls
 
 Some of the guiding design goals for this library:
 

diff --git a/ui/components/package.json b/ui/components/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@component-controls/components",
   "version": "0.6.0",
-  "description": "Component controls user interface components",
+  "description": "Component controls commonly used UI components.",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
   "typings": "dist/index.d.ts",

diff --git a/ui/editors/README.md b/ui/editors/README.md
@@ -18,10 +18,6 @@
 
 # Overview
 
-## @component-controls/editors
-
-A collection of editors used to edit component control values.
-
 Some of the guiding design goals for this library:
 
 -   Extensible using `addPropertyEditor`, so you can replace or add new editors.

diff --git a/ui/editors/package.json b/ui/editors/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@component-controls/editors",
   "version": "0.6.0",
-  "description": "Component controls specification and utility routines",
+  "description": "Component controls editors for component control values.",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
   "typings": "dist/index.d.ts",