-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(fs-path-polling): add fs path polling changelog funcs
- Loading branch information
Showing
110 changed files
with
1,543 additions
and
434 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
[[toc]] | ||
|
||
## 引入方式 | ||
|
||
```ts | ||
import { insertDocChangeLog } from 't-comm'; | ||
|
||
// or | ||
|
||
import { insertDocChangeLog} from 't-comm/lib/change-log/index'; | ||
``` | ||
|
||
|
||
## `insertDocChangeLog(params)` | ||
|
||
|
||
**描述**:<p>同步最新版本的更新日志</p> | ||
|
||
**参数**: | ||
|
||
|
||
| 参数名 | 类型 | 描述 | | ||
| --- | --- | --- | | ||
| params | <code>object</code> | <p>参数</p> | | ||
| params.changelogPath | <code>string</code> | <p>源 change-log路径</p> | | ||
| params.docChangelogPath | <code>string</code> | <p>文档 change-log 路径</p> | | ||
| params.packageJsonPath | <code>string</code> | <p>package.json 路径</p> | | ||
|
||
|
||
|
||
**示例** | ||
|
||
```ts | ||
const DOC_CHANGE_LOG_PATH = './docs/CHANGELOG.md'; | ||
const SOURCE_CHANGE_LOG_PATH = './CHANGELOG.md'; | ||
|
||
insertDocChangeLog({ | ||
changelogPath: SOURCE_CHANGE_LOG_PATH, | ||
docChangeLog: DOC_CHANGE_LOG_PATH, | ||
packageJsonPath: './package.json', | ||
}); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.