mirror of
https://activitypub.software/TransFem-org/sfm-js
synced 2024-12-04 03:37:27 +00:00
Introduce api-extractor and lint
This commit is contained in:
parent
c281499adc
commit
9287a3b5b9
16 changed files with 821 additions and 54 deletions
6
.eslintignore
Normal file
6
.eslintignore
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
node_modules
|
||||||
|
/built
|
||||||
|
/coverage
|
||||||
|
/.eslintrc.js
|
||||||
|
/jest.config.ts
|
||||||
|
parser.js
|
32
.eslintrc.js
Normal file
32
.eslintrc.js
Normal file
|
@ -0,0 +1,32 @@
|
||||||
|
module.exports = {
|
||||||
|
root: true,
|
||||||
|
parser: '@typescript-eslint/parser',
|
||||||
|
plugins: [
|
||||||
|
'@typescript-eslint',
|
||||||
|
],
|
||||||
|
extends: [
|
||||||
|
'eslint:recommended',
|
||||||
|
'plugin:@typescript-eslint/recommended',
|
||||||
|
],
|
||||||
|
rules: {
|
||||||
|
'indent': ['error', 'tab', {
|
||||||
|
'SwitchCase': 1,
|
||||||
|
'flatTernaryExpressions': true,
|
||||||
|
}],
|
||||||
|
'eol-last': ['error', 'always'],
|
||||||
|
'semi': ['error', 'always'],
|
||||||
|
'quotes': ['error', 'single'],
|
||||||
|
'keyword-spacing': ['error', {
|
||||||
|
'before': true,
|
||||||
|
'after': true,
|
||||||
|
}],
|
||||||
|
'no-multi-spaces': ['error'],
|
||||||
|
'no-var': ['error'],
|
||||||
|
'prefer-arrow-callback': ['error'],
|
||||||
|
'no-throw-literal': ['error'],
|
||||||
|
'no-param-reassign': ['warn'],
|
||||||
|
'no-constant-condition': ['warn'],
|
||||||
|
'no-empty-pattern': ['warn'],
|
||||||
|
'@typescript-eslint/no-inferrable-types': ['warn'],
|
||||||
|
},
|
||||||
|
};
|
32
.github/pull_request_template.md
vendored
32
.github/pull_request_template.md
vendored
|
@ -1,21 +1,29 @@
|
||||||
<!-- ℹ お読みください
|
<!-- ℹ お読みください
|
||||||
PRありがとうございます! PRを作成する前に、以下をご確認ください:
|
PRありがとうございます! PRを作成する前に、以下をご確認ください:
|
||||||
可能であればタイトルに、以下で示すようなPRの種類が分かるキーワードをプリフィクスしてください。
|
- 可能であればタイトルに、以下で示すようなPRの種類が分かるキーワードをプリフィクスしてください。
|
||||||
fix / refactor / feat / enhance / perf / chore
|
- fix / refactor / feat / enhance / perf / chore
|
||||||
また、PRの粒度が適切であることを確認してください。ひとつのPRに複数の種類の変更や関心を含めることは避けてください。
|
- また、PRの粒度が適切であることを確認してください。ひとつのPRに複数の種類の変更や関心を含めることは避けてください。
|
||||||
このPRによって解決されるIssueがある場合は、そのIssue IDを本文内に記入してください。
|
- このPRによって解決されるIssueがある場合は、そのIssueへの参照を本文内に含めてください。
|
||||||
CHANGELOG.mdに変更点を追記してください。リファクタリングなど、利用者に影響を与えない変更についてはこの限りではありません。
|
- CHANGELOG.mdに変更点を追記してください。リファクタリングなど、利用者に影響を与えない変更についてはこの限りではありません。
|
||||||
機能追加やバグ修正をした場合は、可能であればテストケースを追加してください。
|
- この変更により新たに作成、もしくは更新すべきドキュメントがないか確認してください。
|
||||||
|
- 機能追加やバグ修正をした場合は、可能であればテストケースを追加してください。
|
||||||
|
- テスト、Lintが通っていることを予め確認してください。
|
||||||
|
- `npm run test`、`npm run lint`でぞれぞれ実施可能です
|
||||||
|
- `npm run api`を実行してAPIレポートを更新し、差分がある場合はコミットしてください。
|
||||||
ご協力ありがとうございます🤗
|
ご協力ありがとうございます🤗
|
||||||
-->
|
-->
|
||||||
<!-- ℹ README
|
<!-- ℹ README
|
||||||
Thank you for your PR! Before creating a PR, please check the following:
|
Thank you for your PR! Before creating a PR, please check the following:
|
||||||
If possible, prefix the title with a keyword that identifies the type of this PR, as shown below.
|
- If possible, prefix the title with a keyword that identifies the type of this PR, as shown below.
|
||||||
fix / refactor / feat / enhance / perf / chore
|
- fix / refactor / feat / enhance / perf / chore
|
||||||
Also, make sure that the granularity of this PR is appropriate. Please do not include more than one type of change or interest in a single PR.
|
- Also, make sure that the granularity of this PR is appropriate. Please do not include more than one type of change or interest in a single PR.
|
||||||
If there is an issue to be resolved by this PR, please include the Issue ID in the text.
|
- If there is an Issue which will be resolved by this PR, please include a reference to the Issue in the text.
|
||||||
Please add the summary of the changes to CHANGELOG.md. However, this is not necessary for changes that do not affect the users, such as refactoring.
|
- Please add the summary of the changes to CHANGELOG.md. However, this is not necessary for changes that do not affect the users, such as refactoring.
|
||||||
If you have added a feature or fixed a bug, please add a test case if possible.
|
- Check if there are any documents that need to be created or updated due to this change.
|
||||||
|
- If you have added a feature or fixed a bug, please add a test case if possible.
|
||||||
|
- Please make sure that tests and Lint are passed in advance.
|
||||||
|
- You can run it with `npm run test` and `npm run lint`.
|
||||||
|
- Run `npm run api` to update the API report and commit it if there are any diffs.
|
||||||
Thanks for your cooperation 🤗
|
Thanks for your cooperation 🤗
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
|
40
.github/workflows/api.yml
vendored
Normal file
40
.github/workflows/api.yml
vendored
Normal file
|
@ -0,0 +1,40 @@
|
||||||
|
name: API report
|
||||||
|
|
||||||
|
on: [push, pull_request]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
report:
|
||||||
|
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Setup Node.js
|
||||||
|
uses: actions/setup-node@v1
|
||||||
|
with:
|
||||||
|
node-version: 16.5.0
|
||||||
|
|
||||||
|
- name: Cache dependencies
|
||||||
|
uses: actions/cache@v2
|
||||||
|
with:
|
||||||
|
path: ~/.npm
|
||||||
|
key: npm-${{ hashFiles('package-lock.json') }}
|
||||||
|
restore-keys: npm-
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Build
|
||||||
|
run: npm run build
|
||||||
|
|
||||||
|
- name: Check files
|
||||||
|
run: ls built
|
||||||
|
|
||||||
|
- name: API report
|
||||||
|
run: npm run api-prod
|
||||||
|
|
||||||
|
- name: Show report
|
||||||
|
if: always()
|
||||||
|
run: cat temp/mfm-js.api.md
|
30
.github/workflows/lint.yml
vendored
Normal file
30
.github/workflows/lint.yml
vendored
Normal file
|
@ -0,0 +1,30 @@
|
||||||
|
name: Lint
|
||||||
|
|
||||||
|
on: [push, pull_request]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
lint:
|
||||||
|
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Setup Node.js
|
||||||
|
uses: actions/setup-node@v1
|
||||||
|
with:
|
||||||
|
node-version: 16.5.0
|
||||||
|
|
||||||
|
- name: Cache dependencies
|
||||||
|
uses: actions/cache@v2
|
||||||
|
with:
|
||||||
|
path: ~/.npm
|
||||||
|
key: npm-${{ hashFiles('package-lock.json') }}
|
||||||
|
restore-keys: npm-
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Lint
|
||||||
|
run: npm run lint
|
53
.github/workflows/test.yml
vendored
53
.github/workflows/test.yml
vendored
|
@ -1,13 +1,9 @@
|
||||||
# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
|
# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
|
||||||
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
|
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
|
||||||
|
|
||||||
name: Test
|
name: Test and coverage
|
||||||
|
|
||||||
on:
|
on: [push, pull_request]
|
||||||
push:
|
|
||||||
branches: [ develop ]
|
|
||||||
pull_request:
|
|
||||||
branches: [ develop ]
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
test:
|
test:
|
||||||
|
@ -16,21 +12,34 @@ jobs:
|
||||||
|
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
node-version: [12.x, 16.x]
|
node-version: [16.5.0]
|
||||||
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/
|
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
- name: Setup Node.js ${{ matrix.node-version }}
|
|
||||||
uses: actions/setup-node@v1
|
- name: Setup Node.js ${{ matrix.node-version }}
|
||||||
with:
|
uses: actions/setup-node@v1
|
||||||
node-version: ${{ matrix.node-version }}
|
with:
|
||||||
- name: Install
|
node-version: ${{ matrix.node-version }}
|
||||||
run: npm i
|
|
||||||
- name: Build
|
- name: Cache dependencies
|
||||||
run: npm run build
|
uses: actions/cache@v2
|
||||||
- name: Test
|
with:
|
||||||
run: npm run test
|
path: ~/.npm
|
||||||
- name: Upload Coverage
|
key: npm-${{ hashFiles('package-lock.json') }}
|
||||||
uses: codecov/codecov-action@v1
|
restore-keys: npm-
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Build
|
||||||
|
run: npm run build
|
||||||
|
|
||||||
|
- name: Test
|
||||||
|
run: npm test
|
||||||
|
env:
|
||||||
|
CI: true
|
||||||
|
|
||||||
|
- name: Upload Coverage
|
||||||
|
uses: codecov/codecov-action@v1
|
||||||
|
|
364
api-extractor.json
Normal file
364
api-extractor.json
Normal file
|
@ -0,0 +1,364 @@
|
||||||
|
/**
|
||||||
|
* Config file for API Extractor. For more info, please visit: https://api-extractor.com
|
||||||
|
*/
|
||||||
|
{
|
||||||
|
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optionally specifies another JSON config file that this file extends from. This provides a way for
|
||||||
|
* standard settings to be shared across multiple projects.
|
||||||
|
*
|
||||||
|
* If the path starts with "./" or "../", the path is resolved relative to the folder of the file that contains
|
||||||
|
* the "extends" field. Otherwise, the first path segment is interpreted as an NPM package name, and will be
|
||||||
|
* resolved using NodeJS require().
|
||||||
|
*
|
||||||
|
* SUPPORTED TOKENS: none
|
||||||
|
* DEFAULT VALUE: ""
|
||||||
|
*/
|
||||||
|
// "extends": "./shared/api-extractor-base.json"
|
||||||
|
// "extends": "my-package/include/api-extractor-base.json"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Determines the "<projectFolder>" token that can be used with other config file settings. The project folder
|
||||||
|
* typically contains the tsconfig.json and package.json config files, but the path is user-defined.
|
||||||
|
*
|
||||||
|
* The path is resolved relative to the folder of the config file that contains the setting.
|
||||||
|
*
|
||||||
|
* The default value for "projectFolder" is the token "<lookup>", which means the folder is determined by traversing
|
||||||
|
* parent folders, starting from the folder containing api-extractor.json, and stopping at the first folder
|
||||||
|
* that contains a tsconfig.json file. If a tsconfig.json file cannot be found in this way, then an error
|
||||||
|
* will be reported.
|
||||||
|
*
|
||||||
|
* SUPPORTED TOKENS: <lookup>
|
||||||
|
* DEFAULT VALUE: "<lookup>"
|
||||||
|
*/
|
||||||
|
// "projectFolder": "..",
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (REQUIRED) Specifies the .d.ts file to be used as the starting point for analysis. API Extractor
|
||||||
|
* analyzes the symbols exported by this module.
|
||||||
|
*
|
||||||
|
* The file extension must be ".d.ts" and not ".ts".
|
||||||
|
*
|
||||||
|
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
|
||||||
|
* prepend a folder token such as "<projectFolder>".
|
||||||
|
*
|
||||||
|
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
|
||||||
|
*/
|
||||||
|
"mainEntryPointFilePath": "<projectFolder>/built/index.d.ts",
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A list of NPM package names whose exports should be treated as part of this package.
|
||||||
|
*
|
||||||
|
* For example, suppose that Webpack is used to generate a distributed bundle for the project "library1",
|
||||||
|
* and another NPM package "library2" is embedded in this bundle. Some types from library2 may become part
|
||||||
|
* of the exported API for library1, but by default API Extractor would generate a .d.ts rollup that explicitly
|
||||||
|
* imports library2. To avoid this, we can specify:
|
||||||
|
*
|
||||||
|
* "bundledPackages": [ "library2" ],
|
||||||
|
*
|
||||||
|
* This would direct API Extractor to embed those types directly in the .d.ts rollup, as if they had been
|
||||||
|
* local files for library1.
|
||||||
|
*/
|
||||||
|
"bundledPackages": [],
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Determines how the TypeScript compiler engine will be invoked by API Extractor.
|
||||||
|
*/
|
||||||
|
"compiler": {
|
||||||
|
/**
|
||||||
|
* Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project.
|
||||||
|
*
|
||||||
|
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
|
||||||
|
* prepend a folder token such as "<projectFolder>".
|
||||||
|
*
|
||||||
|
* Note: This setting will be ignored if "overrideTsconfig" is used.
|
||||||
|
*
|
||||||
|
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
|
||||||
|
* DEFAULT VALUE: "<projectFolder>/tsconfig.json"
|
||||||
|
*/
|
||||||
|
// "tsconfigFilePath": "<projectFolder>/tsconfig.json",
|
||||||
|
/**
|
||||||
|
* Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk.
|
||||||
|
* The object must conform to the TypeScript tsconfig schema:
|
||||||
|
*
|
||||||
|
* http://json.schemastore.org/tsconfig
|
||||||
|
*
|
||||||
|
* If omitted, then the tsconfig.json file will be read from the "projectFolder".
|
||||||
|
*
|
||||||
|
* DEFAULT VALUE: no overrideTsconfig section
|
||||||
|
*/
|
||||||
|
// "overrideTsconfig": {
|
||||||
|
// . . .
|
||||||
|
// }
|
||||||
|
/**
|
||||||
|
* This option causes the compiler to be invoked with the --skipLibCheck option. This option is not recommended
|
||||||
|
* and may cause API Extractor to produce incomplete or incorrect declarations, but it may be required when
|
||||||
|
* dependencies contain declarations that are incompatible with the TypeScript engine that API Extractor uses
|
||||||
|
* for its analysis. Where possible, the underlying issue should be fixed rather than relying on skipLibCheck.
|
||||||
|
*
|
||||||
|
* DEFAULT VALUE: false
|
||||||
|
*/
|
||||||
|
// "skipLibCheck": true,
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Configures how the API report file (*.api.md) will be generated.
|
||||||
|
*/
|
||||||
|
"apiReport": {
|
||||||
|
/**
|
||||||
|
* (REQUIRED) Whether to generate an API report.
|
||||||
|
*/
|
||||||
|
"enabled": true
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The filename for the API report files. It will be combined with "reportFolder" or "reportTempFolder" to produce
|
||||||
|
* a full file path.
|
||||||
|
*
|
||||||
|
* The file extension should be ".api.md", and the string should not contain a path separator such as "\" or "/".
|
||||||
|
*
|
||||||
|
* SUPPORTED TOKENS: <packageName>, <unscopedPackageName>
|
||||||
|
* DEFAULT VALUE: "<unscopedPackageName>.api.md"
|
||||||
|
*/
|
||||||
|
// "reportFileName": "<unscopedPackageName>.api.md",
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specifies the folder where the API report file is written. The file name portion is determined by
|
||||||
|
* the "reportFileName" setting.
|
||||||
|
*
|
||||||
|
* The API report file is normally tracked by Git. Changes to it can be used to trigger a branch policy,
|
||||||
|
* e.g. for an API review.
|
||||||
|
*
|
||||||
|
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
|
||||||
|
* prepend a folder token such as "<projectFolder>".
|
||||||
|
*
|
||||||
|
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
|
||||||
|
* DEFAULT VALUE: "<projectFolder>/etc/"
|
||||||
|
*/
|
||||||
|
// "reportFolder": "<projectFolder>/etc/",
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specifies the folder where the temporary report file is written. The file name portion is determined by
|
||||||
|
* the "reportFileName" setting.
|
||||||
|
*
|
||||||
|
* After the temporary file is written to disk, it is compared with the file in the "reportFolder".
|
||||||
|
* If they are different, a production build will fail.
|
||||||
|
*
|
||||||
|
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
|
||||||
|
* prepend a folder token such as "<projectFolder>".
|
||||||
|
*
|
||||||
|
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
|
||||||
|
* DEFAULT VALUE: "<projectFolder>/temp/"
|
||||||
|
*/
|
||||||
|
// "reportTempFolder": "<projectFolder>/temp/"
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Configures how the doc model file (*.api.json) will be generated.
|
||||||
|
*/
|
||||||
|
"docModel": {
|
||||||
|
/**
|
||||||
|
* (REQUIRED) Whether to generate a doc model file.
|
||||||
|
*/
|
||||||
|
"enabled": true
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The output path for the doc model file. The file extension should be ".api.json".
|
||||||
|
*
|
||||||
|
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
|
||||||
|
* prepend a folder token such as "<projectFolder>".
|
||||||
|
*
|
||||||
|
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
|
||||||
|
* DEFAULT VALUE: "<projectFolder>/temp/<unscopedPackageName>.api.json"
|
||||||
|
*/
|
||||||
|
// "apiJsonFilePath": "<projectFolder>/temp/<unscopedPackageName>.api.json"
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Configures how the .d.ts rollup file will be generated.
|
||||||
|
*/
|
||||||
|
"dtsRollup": {
|
||||||
|
/**
|
||||||
|
* (REQUIRED) Whether to generate the .d.ts rollup file.
|
||||||
|
*/
|
||||||
|
"enabled": false
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specifies the output path for a .d.ts rollup file to be generated without any trimming.
|
||||||
|
* This file will include all declarations that are exported by the main entry point.
|
||||||
|
*
|
||||||
|
* If the path is an empty string, then this file will not be written.
|
||||||
|
*
|
||||||
|
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
|
||||||
|
* prepend a folder token such as "<projectFolder>".
|
||||||
|
*
|
||||||
|
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
|
||||||
|
* DEFAULT VALUE: "<projectFolder>/dist/<unscopedPackageName>.d.ts"
|
||||||
|
*/
|
||||||
|
// "untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release.
|
||||||
|
* This file will include only declarations that are marked as "@public" or "@beta".
|
||||||
|
*
|
||||||
|
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
|
||||||
|
* prepend a folder token such as "<projectFolder>".
|
||||||
|
*
|
||||||
|
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
|
||||||
|
* DEFAULT VALUE: ""
|
||||||
|
*/
|
||||||
|
// "betaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-beta.d.ts",
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release.
|
||||||
|
* This file will include only declarations that are marked as "@public".
|
||||||
|
*
|
||||||
|
* If the path is an empty string, then this file will not be written.
|
||||||
|
*
|
||||||
|
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
|
||||||
|
* prepend a folder token such as "<projectFolder>".
|
||||||
|
*
|
||||||
|
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
|
||||||
|
* DEFAULT VALUE: ""
|
||||||
|
*/
|
||||||
|
// "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts",
|
||||||
|
|
||||||
|
/**
|
||||||
|
* When a declaration is trimmed, by default it will be replaced by a code comment such as
|
||||||
|
* "Excluded from this release type: exampleMember". Set "omitTrimmingComments" to true to remove the
|
||||||
|
* declaration completely.
|
||||||
|
*
|
||||||
|
* DEFAULT VALUE: false
|
||||||
|
*/
|
||||||
|
// "omitTrimmingComments": true
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Configures how the tsdoc-metadata.json file will be generated.
|
||||||
|
*/
|
||||||
|
"tsdocMetadata": {
|
||||||
|
/**
|
||||||
|
* Whether to generate the tsdoc-metadata.json file.
|
||||||
|
*
|
||||||
|
* DEFAULT VALUE: true
|
||||||
|
*/
|
||||||
|
// "enabled": true,
|
||||||
|
/**
|
||||||
|
* Specifies where the TSDoc metadata file should be written.
|
||||||
|
*
|
||||||
|
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
|
||||||
|
* prepend a folder token such as "<projectFolder>".
|
||||||
|
*
|
||||||
|
* The default value is "<lookup>", which causes the path to be automatically inferred from the "tsdocMetadata",
|
||||||
|
* "typings" or "main" fields of the project's package.json. If none of these fields are set, the lookup
|
||||||
|
* falls back to "tsdoc-metadata.json" in the package folder.
|
||||||
|
*
|
||||||
|
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
|
||||||
|
* DEFAULT VALUE: "<lookup>"
|
||||||
|
*/
|
||||||
|
// "tsdocMetadataFilePath": "<projectFolder>/dist/tsdoc-metadata.json"
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specifies what type of newlines API Extractor should use when writing output files. By default, the output files
|
||||||
|
* will be written with Windows-style newlines. To use POSIX-style newlines, specify "lf" instead.
|
||||||
|
* To use the OS's default newline kind, specify "os".
|
||||||
|
*
|
||||||
|
* DEFAULT VALUE: "crlf"
|
||||||
|
*/
|
||||||
|
// "newlineKind": "crlf",
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Configures how API Extractor reports error and warning messages produced during analysis.
|
||||||
|
*
|
||||||
|
* There are three sources of messages: compiler messages, API Extractor messages, and TSDoc messages.
|
||||||
|
*/
|
||||||
|
"messages": {
|
||||||
|
/**
|
||||||
|
* Configures handling of diagnostic messages reported by the TypeScript compiler engine while analyzing
|
||||||
|
* the input .d.ts files.
|
||||||
|
*
|
||||||
|
* TypeScript message identifiers start with "TS" followed by an integer. For example: "TS2551"
|
||||||
|
*
|
||||||
|
* DEFAULT VALUE: A single "default" entry with logLevel=warning.
|
||||||
|
*/
|
||||||
|
"compilerMessageReporting": {
|
||||||
|
/**
|
||||||
|
* Configures the default routing for messages that don't match an explicit rule in this table.
|
||||||
|
*/
|
||||||
|
"default": {
|
||||||
|
/**
|
||||||
|
* Specifies whether the message should be written to the the tool's output log. Note that
|
||||||
|
* the "addToApiReportFile" property may supersede this option.
|
||||||
|
*
|
||||||
|
* Possible values: "error", "warning", "none"
|
||||||
|
*
|
||||||
|
* Errors cause the build to fail and return a nonzero exit code. Warnings cause a production build fail
|
||||||
|
* and return a nonzero exit code. For a non-production build (e.g. when "api-extractor run" includes
|
||||||
|
* the "--local" option), the warning is displayed but the build will not fail.
|
||||||
|
*
|
||||||
|
* DEFAULT VALUE: "warning"
|
||||||
|
*/
|
||||||
|
"logLevel": "warning"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* When addToApiReportFile is true: If API Extractor is configured to write an API report file (.api.md),
|
||||||
|
* then the message will be written inside that file; otherwise, the message is instead logged according to
|
||||||
|
* the "logLevel" option.
|
||||||
|
*
|
||||||
|
* DEFAULT VALUE: false
|
||||||
|
*/
|
||||||
|
// "addToApiReportFile": false
|
||||||
|
}
|
||||||
|
|
||||||
|
// "TS2551": {
|
||||||
|
// "logLevel": "warning",
|
||||||
|
// "addToApiReportFile": true
|
||||||
|
// },
|
||||||
|
//
|
||||||
|
// . . .
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Configures handling of messages reported by API Extractor during its analysis.
|
||||||
|
*
|
||||||
|
* API Extractor message identifiers start with "ae-". For example: "ae-extra-release-tag"
|
||||||
|
*
|
||||||
|
* DEFAULT VALUE: See api-extractor-defaults.json for the complete table of extractorMessageReporting mappings
|
||||||
|
*/
|
||||||
|
"extractorMessageReporting": {
|
||||||
|
"default": {
|
||||||
|
"logLevel": "none"
|
||||||
|
// "addToApiReportFile": false
|
||||||
|
}
|
||||||
|
|
||||||
|
// "ae-extra-release-tag": {
|
||||||
|
// "logLevel": "warning",
|
||||||
|
// "addToApiReportFile": true
|
||||||
|
// },
|
||||||
|
//
|
||||||
|
// . . .
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Configures handling of messages reported by the TSDoc parser when analyzing code comments.
|
||||||
|
*
|
||||||
|
* TSDoc message identifiers start with "tsdoc-". For example: "tsdoc-link-tag-unescaped-text"
|
||||||
|
*
|
||||||
|
* DEFAULT VALUE: A single "default" entry with logLevel=warning.
|
||||||
|
*/
|
||||||
|
"tsdocMessageReporting": {
|
||||||
|
"default": {
|
||||||
|
"logLevel": "warning"
|
||||||
|
// "addToApiReportFile": false
|
||||||
|
}
|
||||||
|
|
||||||
|
// "tsdoc-link-tag-unescaped-text": {
|
||||||
|
// "logLevel": "warning",
|
||||||
|
// "addToApiReportFile": true
|
||||||
|
// },
|
||||||
|
//
|
||||||
|
// . . .
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
268
etc/mfm-js.api.md
Normal file
268
etc/mfm-js.api.md
Normal file
|
@ -0,0 +1,268 @@
|
||||||
|
## API Report File for "mfm-js"
|
||||||
|
|
||||||
|
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||||
|
|
||||||
|
```ts
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export const BOLD: (children: MfmInline[]) => NodeType<'bold'>;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export const CENTER: (children: MfmInline[]) => NodeType<'center'>;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export const CODE_BLOCK: (code: string, lang: string | null) => NodeType<'blockCode'>;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export const EMOJI_CODE: (name: string) => NodeType<'emojiCode'>;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export function extract(nodes: MfmNode[], predicate: (node: MfmNode) => boolean): MfmNode[];
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export const FN: (name: string, args: MfmFn['props']['args'], children: MfmFn['children']) => NodeType<'fn'>;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export const HASHTAG: (value: string) => NodeType<'hashtag'>;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export const INLINE_CODE: (code: string) => NodeType<'inlineCode'>;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export function inspect(node: MfmNode, action: (node: MfmNode) => void): void;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export function inspect(nodes: MfmNode[], action: (node: MfmNode) => void): void;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export const ITALIC: (children: MfmInline[]) => NodeType<'italic'>;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export const LINK: (silent: boolean, url: string, children: MfmInline[]) => NodeType<'link'>;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export const MATH_BLOCK: (formula: string) => NodeType<'mathBlock'>;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export const MATH_INLINE: (formula: string) => NodeType<'mathInline'>;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export const MENTION: (username: string, host: string | null, acct: string) => NodeType<'mention'>;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmBlock = MfmQuote | MfmSearch | MfmCodeBlock | MfmMathBlock | MfmCenter;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmBold = {
|
||||||
|
type: 'bold';
|
||||||
|
props?: Record<string, unknown>;
|
||||||
|
children: MfmInline[];
|
||||||
|
};
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmCenter = {
|
||||||
|
type: 'center';
|
||||||
|
props?: Record<string, unknown>;
|
||||||
|
children: MfmInline[];
|
||||||
|
};
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmCodeBlock = {
|
||||||
|
type: 'blockCode';
|
||||||
|
props: {
|
||||||
|
code: string;
|
||||||
|
lang: string | null;
|
||||||
|
};
|
||||||
|
children?: [];
|
||||||
|
};
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmEmojiCode = {
|
||||||
|
type: 'emojiCode';
|
||||||
|
props: {
|
||||||
|
name: string;
|
||||||
|
};
|
||||||
|
children?: [];
|
||||||
|
};
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmFn = {
|
||||||
|
type: 'fn';
|
||||||
|
props: {
|
||||||
|
name: string;
|
||||||
|
args: Record<string, string | true>;
|
||||||
|
};
|
||||||
|
children: MfmInline[];
|
||||||
|
};
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmHashtag = {
|
||||||
|
type: 'hashtag';
|
||||||
|
props: {
|
||||||
|
hashtag: string;
|
||||||
|
};
|
||||||
|
children?: [];
|
||||||
|
};
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmInline = MfmUnicodeEmoji | MfmEmojiCode | MfmBold | MfmSmall | MfmItalic | MfmStrike | MfmInlineCode | MfmMathInline | MfmMention | MfmHashtag | MfmUrl | MfmLink | MfmFn | MfmText;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmInlineCode = {
|
||||||
|
type: 'inlineCode';
|
||||||
|
props: {
|
||||||
|
code: string;
|
||||||
|
};
|
||||||
|
children?: [];
|
||||||
|
};
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmItalic = {
|
||||||
|
type: 'italic';
|
||||||
|
props?: Record<string, unknown>;
|
||||||
|
children: MfmInline[];
|
||||||
|
};
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmLink = {
|
||||||
|
type: 'link';
|
||||||
|
props: {
|
||||||
|
silent: boolean;
|
||||||
|
url: string;
|
||||||
|
};
|
||||||
|
children: MfmInline[];
|
||||||
|
};
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmMathBlock = {
|
||||||
|
type: 'mathBlock';
|
||||||
|
props: {
|
||||||
|
formula: string;
|
||||||
|
};
|
||||||
|
children?: [];
|
||||||
|
};
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmMathInline = {
|
||||||
|
type: 'mathInline';
|
||||||
|
props: {
|
||||||
|
formula: string;
|
||||||
|
};
|
||||||
|
children?: [];
|
||||||
|
};
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmMention = {
|
||||||
|
type: 'mention';
|
||||||
|
props: {
|
||||||
|
username: string;
|
||||||
|
host: string | null;
|
||||||
|
acct: string;
|
||||||
|
};
|
||||||
|
children?: [];
|
||||||
|
};
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmNode = MfmBlock | MfmInline;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmQuote = {
|
||||||
|
type: 'quote';
|
||||||
|
props?: Record<string, unknown>;
|
||||||
|
children: MfmNode[];
|
||||||
|
};
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmSearch = {
|
||||||
|
type: 'search';
|
||||||
|
props: {
|
||||||
|
query: string;
|
||||||
|
content: string;
|
||||||
|
};
|
||||||
|
children?: [];
|
||||||
|
};
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmSmall = {
|
||||||
|
type: 'small';
|
||||||
|
props?: Record<string, unknown>;
|
||||||
|
children: MfmInline[];
|
||||||
|
};
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmStrike = {
|
||||||
|
type: 'strike';
|
||||||
|
props?: Record<string, unknown>;
|
||||||
|
children: MfmInline[];
|
||||||
|
};
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmText = {
|
||||||
|
type: 'text';
|
||||||
|
props: {
|
||||||
|
text: string;
|
||||||
|
};
|
||||||
|
children?: [];
|
||||||
|
};
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmUnicodeEmoji = {
|
||||||
|
type: 'unicodeEmoji';
|
||||||
|
props: {
|
||||||
|
emoji: string;
|
||||||
|
};
|
||||||
|
children?: [];
|
||||||
|
};
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type MfmUrl = {
|
||||||
|
type: 'url';
|
||||||
|
props: {
|
||||||
|
url: string;
|
||||||
|
brackets?: boolean;
|
||||||
|
};
|
||||||
|
children?: [];
|
||||||
|
};
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export const N_URL: (value: string, brackets?: boolean | undefined) => NodeType<'url'>;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export type NodeType<T extends MfmNode['type']> = T extends 'quote' ? MfmQuote : T extends 'search' ? MfmSearch : T extends 'blockCode' ? MfmCodeBlock : T extends 'mathBlock' ? MfmMathBlock : T extends 'center' ? MfmCenter : T extends 'unicodeEmoji' ? MfmUnicodeEmoji : T extends 'emojiCode' ? MfmEmojiCode : T extends 'bold' ? MfmBold : T extends 'small' ? MfmSmall : T extends 'italic' ? MfmItalic : T extends 'strike' ? MfmStrike : T extends 'inlineCode' ? MfmInlineCode : T extends 'mathInline' ? MfmMathInline : T extends 'mention' ? MfmMention : T extends 'hashtag' ? MfmHashtag : T extends 'url' ? MfmUrl : T extends 'link' ? MfmLink : T extends 'fn' ? MfmFn : T extends 'text' ? MfmText : never;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export function parse(input: string): MfmNode[];
|
||||||
|
|
||||||
|
// Warning: (ae-forgotten-export) The symbol "MfmPlainNode" needs to be exported by the entry point index.d.ts
|
||||||
|
//
|
||||||
|
// @public (undocumented)
|
||||||
|
export function parsePlain(input: string): MfmPlainNode[];
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export const QUOTE: (children: MfmNode[]) => NodeType<'quote'>;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export const SEARCH: (query: string, content: string) => NodeType<'search'>;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export const SMALL: (children: MfmInline[]) => NodeType<'small'>;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export const STRIKE: (children: MfmInline[]) => NodeType<'strike'>;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export const TEXT: (value: string) => NodeType<'text'>;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
function toString_2(tree: MfmNode[]): string;
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
function toString_2(node: MfmNode): string;
|
||||||
|
export { toString_2 as toString }
|
||||||
|
|
||||||
|
// @public (undocumented)
|
||||||
|
export const UNI_EMOJI: (value: string) => NodeType<'unicodeEmoji'>;
|
||||||
|
|
||||||
|
// (No @packageDocumentation comment for this package)
|
||||||
|
|
||||||
|
```
|
|
@ -14,6 +14,9 @@
|
||||||
"tsd": "tsd",
|
"tsd": "tsd",
|
||||||
"parse": "node ./built/cli/parse",
|
"parse": "node ./built/cli/parse",
|
||||||
"parse-plain": "node ./built/cli/parsePlain",
|
"parse-plain": "node ./built/cli/parsePlain",
|
||||||
|
"api": "npx api-extractor run --local --verbose",
|
||||||
|
"api-prod": "npx api-extractor run --verbose",
|
||||||
|
"lint": "eslint . --ext .js,.jsx,.ts,.tsx",
|
||||||
"jest": "jest --coverage",
|
"jest": "jest --coverage",
|
||||||
"test": "npm run jest && npm run tsd"
|
"test": "npm run jest && npm run tsd"
|
||||||
},
|
},
|
||||||
|
@ -24,9 +27,13 @@
|
||||||
"author": "Marihachi",
|
"author": "Marihachi",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
|
"@microsoft/api-extractor": "^7.18.4",
|
||||||
"@types/jest": "^26.0.23",
|
"@types/jest": "^26.0.23",
|
||||||
"@types/node": "15.12.4",
|
"@types/node": "15.12.4",
|
||||||
|
"@typescript-eslint/eslint-plugin": "^4.28.5",
|
||||||
|
"@typescript-eslint/parser": "^4.28.5",
|
||||||
"copyfiles": "^2.4.1",
|
"copyfiles": "^2.4.1",
|
||||||
|
"eslint": "^7.32.0",
|
||||||
"jest": "^27.0.5",
|
"jest": "^27.0.5",
|
||||||
"peggy": "1.2.0",
|
"peggy": "1.2.0",
|
||||||
"ts-jest": "^27.0.3",
|
"ts-jest": "^27.0.3",
|
||||||
|
|
|
@ -2,6 +2,7 @@ import peg from 'peggy';
|
||||||
import { MfmNode, MfmPlainNode } from './node';
|
import { MfmNode, MfmPlainNode } from './node';
|
||||||
import { stringifyNode, stringifyTree, inspectOne } from './internal/util';
|
import { stringifyNode, stringifyTree, inspectOne } from './internal/util';
|
||||||
|
|
||||||
|
// eslint-disable-next-line @typescript-eslint/no-var-requires
|
||||||
const parser: peg.Parser = require('./internal/parser');
|
const parser: peg.Parser = require('./internal/parser');
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -39,8 +39,9 @@ async function entryPoint() {
|
||||||
console.log();
|
console.log();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
entryPoint()
|
entryPoint()
|
||||||
.catch(err => {
|
.catch(err => {
|
||||||
console.log(err);
|
console.log(err);
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
});
|
});
|
||||||
|
|
|
@ -39,8 +39,9 @@ async function entryPoint() {
|
||||||
console.log();
|
console.log();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
entryPoint()
|
entryPoint()
|
||||||
.catch(err => {
|
.catch(err => {
|
||||||
console.log(err);
|
console.log(err);
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
});
|
});
|
||||||
|
|
|
@ -30,7 +30,7 @@ export function mergeText(nodes: (MfmNode | string)[]): MfmNode[] {
|
||||||
}
|
}
|
||||||
|
|
||||||
export function stringifyNode(node: MfmNode): string {
|
export function stringifyNode(node: MfmNode): string {
|
||||||
switch(node.type) {
|
switch (node.type) {
|
||||||
// block
|
// block
|
||||||
case 'quote': {
|
case 'quote': {
|
||||||
return stringifyTree(node.children).split('\n').map(line => `> ${line}`).join('\n');
|
return stringifyTree(node.children).split('\n').map(line => `> ${line}`).join('\n');
|
||||||
|
@ -114,10 +114,10 @@ enum stringifyState {
|
||||||
none = 0,
|
none = 0,
|
||||||
inline,
|
inline,
|
||||||
block
|
block
|
||||||
};
|
}
|
||||||
|
|
||||||
export function stringifyTree(nodes: MfmNode[]): string {
|
export function stringifyTree(nodes: MfmNode[]): string {
|
||||||
let dest: MfmNode[] = [];
|
const dest: MfmNode[] = [];
|
||||||
let state: stringifyState = stringifyState.none;
|
let state: stringifyState = stringifyState.none;
|
||||||
|
|
||||||
for (const node of nodes) {
|
for (const node of nodes) {
|
||||||
|
|
12
src/node.ts
12
src/node.ts
|
@ -11,7 +11,7 @@ export function isMfmBlock(node: MfmNode): node is MfmBlock {
|
||||||
|
|
||||||
export type MfmQuote = {
|
export type MfmQuote = {
|
||||||
type: 'quote';
|
type: 'quote';
|
||||||
props?: { };
|
props?: Record<string, unknown>;
|
||||||
children: MfmNode[];
|
children: MfmNode[];
|
||||||
};
|
};
|
||||||
export const QUOTE = (children: MfmNode[]): NodeType<'quote'> => { return { type:'quote', children }; };
|
export const QUOTE = (children: MfmNode[]): NodeType<'quote'> => { return { type:'quote', children }; };
|
||||||
|
@ -47,7 +47,7 @@ export const MATH_BLOCK = (formula: string): NodeType<'mathBlock'> => { return {
|
||||||
|
|
||||||
export type MfmCenter = {
|
export type MfmCenter = {
|
||||||
type: 'center';
|
type: 'center';
|
||||||
props?: { };
|
props?: Record<string, unknown>;
|
||||||
children: MfmInline[];
|
children: MfmInline[];
|
||||||
};
|
};
|
||||||
export const CENTER = (children: MfmInline[]): NodeType<'center'> => { return { type:'center', children }; };
|
export const CENTER = (children: MfmInline[]): NodeType<'center'> => { return { type:'center', children }; };
|
||||||
|
@ -75,28 +75,28 @@ export const EMOJI_CODE = (name: string): NodeType<'emojiCode'> => { return { ty
|
||||||
|
|
||||||
export type MfmBold = {
|
export type MfmBold = {
|
||||||
type: 'bold';
|
type: 'bold';
|
||||||
props?: { };
|
props?: Record<string, unknown>;
|
||||||
children: MfmInline[];
|
children: MfmInline[];
|
||||||
};
|
};
|
||||||
export const BOLD = (children: MfmInline[]): NodeType<'bold'> => { return { type:'bold', children }; };
|
export const BOLD = (children: MfmInline[]): NodeType<'bold'> => { return { type:'bold', children }; };
|
||||||
|
|
||||||
export type MfmSmall = {
|
export type MfmSmall = {
|
||||||
type: 'small';
|
type: 'small';
|
||||||
props?: { };
|
props?: Record<string, unknown>;
|
||||||
children: MfmInline[];
|
children: MfmInline[];
|
||||||
};
|
};
|
||||||
export const SMALL = (children: MfmInline[]): NodeType<'small'> => { return { type:'small', children }; };
|
export const SMALL = (children: MfmInline[]): NodeType<'small'> => { return { type:'small', children }; };
|
||||||
|
|
||||||
export type MfmItalic = {
|
export type MfmItalic = {
|
||||||
type: 'italic';
|
type: 'italic';
|
||||||
props?: { };
|
props?: Record<string, unknown>;
|
||||||
children: MfmInline[];
|
children: MfmInline[];
|
||||||
};
|
};
|
||||||
export const ITALIC = (children: MfmInline[]): NodeType<'italic'> => { return { type:'italic', children }; };
|
export const ITALIC = (children: MfmInline[]): NodeType<'italic'> => { return { type:'italic', children }; };
|
||||||
|
|
||||||
export type MfmStrike = {
|
export type MfmStrike = {
|
||||||
type: 'strike';
|
type: 'strike';
|
||||||
props?: { };
|
props?: Record<string, unknown>;
|
||||||
children: MfmInline[];
|
children: MfmInline[];
|
||||||
};
|
};
|
||||||
export const STRIKE = (children: MfmInline[]): NodeType<'strike'> => { return { type:'strike', children }; };
|
export const STRIKE = (children: MfmInline[]): NodeType<'strike'> => { return { type:'strike', children }; };
|
||||||
|
|
|
@ -21,10 +21,10 @@ after`;
|
||||||
});
|
});
|
||||||
|
|
||||||
it('preserve url brackets', () => {
|
it('preserve url brackets', () => {
|
||||||
const input1 = `https://github.com/syuilo/ai`;
|
const input1 = 'https://github.com/syuilo/ai';
|
||||||
assert.strictEqual(mfm.toString(mfm.parse(input1)), input1);
|
assert.strictEqual(mfm.toString(mfm.parse(input1)), input1);
|
||||||
|
|
||||||
const input2 = `<https://github.com/syuilo/ai>`;
|
const input2 = '<https://github.com/syuilo/ai>';
|
||||||
assert.strictEqual(mfm.toString(mfm.parse(input2)), input2);
|
assert.strictEqual(mfm.toString(mfm.parse(input2)), input2);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
|
@ -123,7 +123,7 @@ describe('FullParser', () => {
|
||||||
assert.deepStrictEqual(mfm.parse(input), output);
|
assert.deepStrictEqual(mfm.parse(input), output);
|
||||||
});
|
});
|
||||||
it('1行の引用ブロックを空行にはできない', () => {
|
it('1行の引用ブロックを空行にはできない', () => {
|
||||||
const input = `> `;
|
const input = '> ';
|
||||||
const output = [
|
const output = [
|
||||||
TEXT('> ')
|
TEXT('> ')
|
||||||
];
|
];
|
||||||
|
|
Loading…
Reference in a new issue