Fix readme for Npm (#20)

Author: joachimdalen

.azext/changelog-cache.json

@@ -30,6 +30,13 @@
     }
   ],
   "pullRequests": [
+    {
+      "id": 808530277,
+      "number": 20,
+      "submitter": "joachimdalen",
+      "title": "Fix readme for Npm",
+      "url": "https://github.com/joachimdalen/azext/pull/20"
+    },
     {
       "id": 807673980,
       "number": 16,

.azext/changelog.json

@@ -1,4 +1,21 @@
 [
+  {
+    "publishDate": "2021-12-22",
+    "version": "0.2.1",
+    "modules": [
+      {
+        "name": "core",
+        "version": "0.2.1",
+        "changes": [
+          {
+            "type": "docs",
+            "description": "Updated NPM readme",
+            "pullRequest": 20
+          }
+        ]
+      }
+    ]
+  },
   {
     "publishDate": "2021-12-22",
     "version": "0.2.0",

npm.md

@@ -9,7 +9,7 @@
   <p align="center">
     A collection of tools to help with developing extensions for Azure DevOps.
     <br />
-    <a href="https://github.com/joachimdalen/azext"><strong>Explore the docs »</strong></a>
+    <a href="https://github.com/joachimdalen/azext/blob/master/docs/index.md"><strong>Explore the docs »</strong></a>
     <br />
     <br />
     <a href="https://www.npmjs.com/package/@joachimdalen/azext">View Package</a>
@@ -34,12 +34,26 @@
 
 AzExt provides a set of utilities to help with developing Extensions for Azure DevOps.
 
-| Command     | Description                             |
-| ----------- | --------------------------------------- |
-| `init`      | Generate default config folder          |
-| `changelog` | Tools to manage and generate changelogs |
+[//]: # "#help-definition[command=help]"
 
-Full documentation is available on GitHub.
+```text
+
+Command List
+
+  init        Generate default config folder
+  changelog   Tools to manage and generate changelogs
+  readme      Tools to manage and generate partial documentation
+  help        Print this usage guide.
+
+Global Options
+
+  --ci string   Run in CI mode. Currenctly supported: ado (Azure DevOps) --ci=ado
+
+```
+
+[//]: # "#help-definition[end]"
+
+Full documentation is available on [GitHub](https://github.com/joachimdalen/azext/blob/master/docs/index.md).
 
 ## License
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@joachimdalen/azext",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "A collection of utilities to help with extension development for Azure DevOps",
   "main": "dist/azext.js",
   "bin": {

scripts/readme-generation.ts

@@ -8,8 +8,6 @@ import glob from 'glob';
 import { isModuleInstalled } from '../src/core/addons-checker';
 import { globalOptionsSection } from '../src/cli/models';
 
-const filePattern = '../docs/**/*.md';
-
 const globFiles = function (pattern: string): Promise<string[] | undefined> {
   return new Promise((resolve, reject) => {
     glob(pattern, (err, files) =>
@@ -26,12 +24,12 @@ const pattern = [
 const fullMatch =
   /(?<fullcontent>(?<start>\[\/\/\]\:\s#\s["']#(?<startidentifier>.+)\[command=(?<startcommand>.+)\]["'])(?<content>[\S\s]+)(?<end>\[\/\/\]\:\s#\s["']#(?<endidentifier>.+)\[end\]["']))/gm;
 
-//const files = ['../docs/changelog/generate.md', '../docs/changelog/config.md'];
-
-const replaceDefinitions = async () => {
-  console.log(chalk.greenBright('Starting documentation processing'));
+const replaceDefinitions = async (path: string) => {
+  console.log(
+    chalk.greenBright(`Starting documentation processing for pattern: ${path}`)
+  );
   const cli = new AzExtCli();
-  const files = await globFiles(filePattern);
+  const files = await globFiles(path);
 
   if (files === undefined) {
     console.error(chalk.redBright('Unable to find files'));
@@ -68,7 +66,8 @@ const replaceDefinitions = async () => {
       if (command && fullContent) {
         const result = cli.parse(command);
 
-        const sections = result.data?.parent?.sections || result.data?.command?.sections;
+        const sections =
+          result.data?.parent?.sections || result.data?.command?.sections;
         if (sections) {
           const dt = [...sections, globalOptionsSection];
           dt.splice(0, introSections.length);
@@ -112,6 +111,12 @@ const replaceDefinitions = async () => {
   }
 };
 
-replaceDefinitions().then(() =>
+const replaceMultiple = async (patterns: string[]) => {
+  for (const pattern of patterns) {
+    await replaceDefinitions(pattern);
+  }
+};
+
+replaceMultiple(['../docs/**/*.md', '../npm.md']).then(() =>
   console.log(chalk.bgGreenBright.black('Processing completed'))
 );

src/version.ts

@@ -1 +1 @@
-export const LIB_VERSION = '0.2.0';
+export const LIB_VERSION = '0.2.1';