feat(contented): add cli to write, generate, build (#2)

Author: fuxingloh

.eslintrc

@@ -1,7 +1,13 @@
 {
   "plugins": ["simple-import-sort"],
   "extends": ["airbnb-base", "airbnb-typescript/base", "prettier"],
-  "ignorePatterns": ["**/*.config.ts", "**/*.config.js"],
+  "ignorePatterns": [
+    "**/*.config.ts",
+    "**/*.config.js",
+    "contented.js",
+    "**/contented-processor/**/*.d.ts",
+    "**/contented-processor/**/*.js"
+  ],
   "rules": {
     "class-methods-use-this": "off",
     "import/no-extraneous-dependencies": "off",

.github/dependabot.yml

@@ -1,22 +1,22 @@
 version: 2
 updates:
-  - package-ecosystem: "npm"
-    directory: "/"
+  - package-ecosystem: 'npm'
+    directory: '/'
     schedule:
-      interval: "daily"
+      interval: 'daily'
     labels:
-      - "kind/dependencies"
-    versioning-strategy: "increase"
+      - 'kind/dependencies'
+    versioning-strategy: 'increase'
     commit-message:
       include: scope
       prefix: bump
 
-  - package-ecosystem: "github-actions"
-    directory: "/"
+  - package-ecosystem: 'github-actions'
+    directory: '/'
     schedule:
-      interval: "daily"
+      interval: 'daily'
     labels:
-      - "kind/dependencies"
+      - 'kind/dependencies'
     commit-message:
       include: scope
       prefix: bump

.github/governance.yml

@@ -3,7 +3,7 @@ version: v1
 issue:
   labels:
     - prefix: triage
-      list: ["accepted"]
+      list: ['accepted']
       multiple: false
       author_association:
         collaborator: true
@@ -50,7 +50,7 @@ issue:
 
     - prefix: priority
       multiple: false
-      list: ["urgent-now", "important-soon"]
+      list: ['urgent-now', 'important-soon']
       author_association:
         collaborator: true
         member: true

.github/labeler.yml

@@ -34,13 +34,13 @@ labels:
   - label: area/workflow
     sync: true
     matcher:
-      files: ".github/**"
+      files: '.github/**'
 
 checks:
-  - context: "Semantic Pull Request"
+  - context: 'Semantic Pull Request'
     description:
       success: Ready for review & merge.
-      failure: "Missing semantic title or label for merge [kind(directory): title]"
+      failure: 'Missing semantic title or label for merge [kind(directory): title]'
     labels:
       any:
         - kind/feature

.github/release-drafter.yml

@@ -1,26 +1,26 @@
-name-template: "v$RESOLVED_VERSION"
-tag-template: "v$RESOLVED_VERSION"
+name-template: 'v$RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
 categories:
-  - title: "Features"
+  - title: 'Features'
     labels:
-      - "kind/feature"
-  - title: "Fixes"
+      - 'kind/feature'
+  - title: 'Fixes'
     labels:
-      - "kind/fix"
-  - title: "Chore & Maintenance"
+      - 'kind/fix'
+  - title: 'Chore & Maintenance'
     labels:
-      - "kind/refactor"
-      - "kind/chore"
-      - "kind/docs"
-  - title: "Dependencies"
+      - 'kind/refactor'
+      - 'kind/chore'
+      - 'kind/docs'
+  - title: 'Dependencies'
     labels:
-      - "kind/dependencies"
-change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
+      - 'kind/dependencies'
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
 change-title-escapes: '\<*_&'
 version-resolver:
   minor:
     labels:
-      - "kind/feature"
+      - 'kind/feature'
   default: patch
 prerelease: false
 template: |

package-lock.json

@@ -10,6 +10,10 @@
     "lint": "eslint --fix . && prettier --write .",
     "prepare": "husky install"
   },
+  "dependencies": {
+    "@birthdayresearch/contented-preview": "0.0.0",
+    "@birthdayresearch/contented-processor": "0.0.0"
+  },
   "devDependencies": {
     "@types/lodash": "^4.14.182",
     "@types/node": "16.11.43",

package.json

@@ -1,43 +1,37 @@
-import { defineDocumentType } from "@birthdayresearch/contented-processor";
-import { computeContentHeadings } from "@birthdayresearch/contented-processor/fields/headings";
+/* eslint-disable */
 import {
+  defineDocumentType,
+  getUnifiedProcessor,
+  computeContentHeadings,
   computePath,
   computeSections,
-} from "@birthdayresearch/contented-processor/fields/path";
+} from '../contented-processor';
 
 const Doc = defineDocumentType(() => ({
-  name: "Doc",
+  name: 'Doc',
   filePathPattern: `docs/**/*.md`,
   fields: {
     title: {
-      type: "string",
-      description: "The title of the documentation.",
+      type: 'string',
+      description: 'The title of the documentation.',
       required: true,
-      default: "Contented Documentation",
+      default: 'Contented Documentation',
     },
     description: {
-      type: "string",
+      type: 'string',
       required: false,
     },
   },
   computedFields: {
-    path: computePath("/", /\d+:/g, ""),
-    sections: computeSections(/docs\/?/g, /\d+:/g, ""),
+    path: computePath('/', /\d+:/g, ''),
+    sections: computeSections(/docs\/?/g, /\d+:/g, ''),
     contentHeadings: computeContentHeadings(),
   },
 }));
 
 /** @type {ContentedConfig} */
 export default {
-  preview: {
-    url: "https://contented.dev",
-    name: "Contented Documentation",
-    github: {
-      url: "https://github.com/BirthdayResearch/contented",
-    },
-  },
-  processor: {
-    rootDir: "./",
-    types: [Doc],
-  },
+  rootDir: './',
+  unified: getUnifiedProcessor,
+  types: [Doc],
 };

packages/contented-example/contented.js

@@ -9,9 +9,9 @@ A `Promise<?>` based design is used as async/await implementation are very matur
 life to modern development.
 
 ```js
-import { JsonRpcClient } from "@defichain/jellyfish-api-jsonrpc";
+import { JsonRpcClient } from '@defichain/jellyfish-api-jsonrpc';
 
-const client = new JsonRpcClient("http://foo:bar@localhost:8554");
+const client = new JsonRpcClient('http://foo:bar@localhost:8554');
 const { blocks } = await client.mining.getMiningInfo();
 ```
 
@@ -21,10 +21,10 @@ Due to the dynamic nature of the JavaScript language, it forces all number to be
 cause precision to be lost. [JellyfishSDK/jellyfish/issues/18](https://github.com/JellyfishSDK/jellyfish/issues/18)
 
 ```js
-it("lost precision converting DFI 😥", () => {
+it('lost precision converting DFI 😥', () => {
   const n = 1200000000.00000001;
   const a = JSON.parse(JSON.stringify(n)) * 1.0e8;
-  expect(a.toString()).toStrictEqual("120000000000000001");
+  expect(a.toString()).toStrictEqual('120000000000000001');
 });
 ```
 
@@ -51,15 +51,8 @@ wallet or transaction related operations. While IEEE-754 number is used for all
 
 ```ts {3}
 export class Wallet {
-  async getBalance(
-    minimumConfirmation: number = 0,
-    includeWatchOnly: boolean = false
-  ): Promise<BigNumber> {
-    return await this.client.call(
-      "getbalance",
-      ["*", minimumConfirmation, includeWatchOnly],
-      "bignumber"
-    );
+  async getBalance(minimumConfirmation: number = 0, includeWatchOnly: boolean = false): Promise<BigNumber> {
+    return await this.client.call('getbalance', ['*', minimumConfirmation, includeWatchOnly], 'bignumber');
   }
 }
 ```
@@ -72,19 +65,12 @@ export interface MiningInfo {
 }
 
 export class Mining {
-  async getNetworkHashPerSecond(
-    nblocks: number = 120,
-    height: number = -1
-  ): Promise<number> {
-    return await this.client.call(
-      "getnetworkhashps",
-      [nblocks, height],
-      "number"
-    );
+  async getNetworkHashPerSecond(nblocks: number = 120, height: number = -1): Promise<number> {
+    return await this.client.call('getnetworkhashps', [nblocks, height], 'number');
   }
 
   async getMiningInfo(): Promise<MiningInfo> {
-    return await this.client.call("getmininginfo", [], "number");
+    return await this.client.call('getmininginfo', [], 'number');
   }
 }
 ```
@@ -116,10 +102,6 @@ export abstract class ApiClient {
    * @throws RpcApiError
    * @throws ClientApiError
    */
-  abstract call<T>(
-    method: string,
-    params: any[],
-    precision: Precision
-  ): Promise<T>;
+  abstract call<T>(method: string, params: any[], precision: Precision): Promise<T>;
 }
 ```

packages/contented-example/docs/03:Jellyfish/02-design.md

@@ -11,25 +11,25 @@ npm i defichain @defichain/jellyfish-api-jsonrpc
 ## JsonRpcClient
 
 ```ts
-import { JsonRpcClient } from "@defichain/jellyfish-api-jsonrpc";
+import { JsonRpcClient } from '@defichain/jellyfish-api-jsonrpc';
 
-const client = new JsonRpcClient("http://foo:bar@localhost:8554");
+const client = new JsonRpcClient('http://foo:bar@localhost:8554');
 ```
 
 ## ApiClient
 
 You can extend `ApiClient` with the `@defichain/jellyfish-api-core` package to create your own transport exchange specification.
 
 ```ts
-import { ApiClient } from "@defichain/jellyfish-api-core";
+import { ApiClient } from '@defichain/jellyfish-api-core';
 
 class SpecClient extends ApiClient {
   async call<T>(method: string, payload: any[]): Promise<T> {
-    throw new ClientApiError("error from client");
+    throw new ClientApiError('error from client');
   }
 }
 
-const client = new SpecClient("http://localhost:8554");
+const client = new SpecClient('http://localhost:8554');
 ```
 
 ## `call` Method
@@ -41,5 +41,5 @@ You can use the `.call` method directly by specifying:
 3. number precision for parse
 
 ```ts
-const result = await client.call("methodname", ["p1", "p2"], "number");
+const result = await client.call('methodname', ['p1', 'p2'], 'number');
 ```

packages/contented-example/docs/03:Jellyfish/03-usage.md

@@ -15,7 +15,7 @@ As with all modern JavaScript projects, jellyfish follows a monorepo structure w
 maintained in this repo are published with the same version tag and follows the `DeFiCh/ain` releases.
 
 | Package                                      | Description                                                                                                            |
-|----------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
+| -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
 | `@defichain/jellyfish-address`               | Provide address builder, parser, validator utility library for DeFi Blockchain.                                        |
 | `@defichain/jellyfish-api-core`              | A protocol agnostic DeFi Blockchain client interfaces, with a "foreign function interface" design.                     |
 | `@defichain/jellyfish-api-jsonrpc`           | Implements the [JSON-RPC 1.0](https://www.jsonrpc.org/specification_v1) specification for api-core.                    |