;
3 |
4 | export function isPlainObject(obj: any): obj is PlainObject {
5 | return obj && obj.constructor === Object;
6 | }
7 |
8 | export function error2String(err: unknown) {
9 | if (typeof err === 'string') {
10 | return err;
11 | }
12 | if (err instanceof Error) {
13 | return `${err.name}: ${err.message}`;
14 | }
15 | if (isPlainObject(err)) {
16 | if (typeof err.msg === 'string') {
17 | return err.msg;
18 | }
19 | if (typeof err.message === 'string') {
20 | return err.message;
21 | }
22 | }
23 | return JSON.stringify(err);
24 | }
25 |
--------------------------------------------------------------------------------
/patches/vitepress+0.21.4.patch:
--------------------------------------------------------------------------------
1 | diff --git a/node_modules/vitepress/dist/node/serve-9731a371.js b/node_modules/vitepress/dist/node/serve-9731a371.js
2 | index e105cda..9aad64b 100644
3 | --- a/node_modules/vitepress/dist/node/serve-9731a371.js
4 | +++ b/node_modules/vitepress/dist/node/serve-9731a371.js
5 | @@ -34335,7 +34335,7 @@ const highlight = (str, lang) => {
6 | }
7 | return wrap(str, "text");
8 | };
9 | -
10 | +exports.highlight = highlight
11 | var remove = removeDiacritics;
12 |
13 | var replacementList = [
14 | @@ -36647,7 +36647,7 @@ function createVitePressPlugin(root, siteConfig, ssr = false, pageToHashMap, cli
15 | },
16 | renderStart() {
17 | if (hasDeadLinks) {
18 | - throw new Error(`One or more pages contain dead links.`);
19 | + // throw new Error(`One or more pages contain dead links.`);
20 | }
21 | },
22 | configureServer(server) {
23 |
--------------------------------------------------------------------------------
/readme.md:
--------------------------------------------------------------------------------
1 | # Async Utilities
2 |
3 |
4 | 
5 | 
6 | 
7 | 
8 |
9 | 
10 | 
11 | 
12 |
13 |
14 | 一个异步工具库，风格以高阶函数为主。
15 |
16 | An asynchronous tools library in the style of higher-order functions. [Website](https://bowencool.github.io/async-utilities/)
17 |
18 | # Usage
19 |
20 | 使用 npm：
21 |
22 | ```bash
23 | npm i @bowencool/async-utilities
24 | ```
25 |
26 | ```ts
27 | import { throttleAsyncResult } from '@bowencool/async-utilities';
28 | ```
29 |
30 | 在浏览器中：
31 |
32 | ```html
33 |
34 |
35 |
36 | ```
37 |
38 | # Todo
39 |
40 | - ~~cacheAsync~~ see [memoizee](https://github.com/medikoo/memoizee#memoizing-asynchronous-functions) or [lru-pcache](https://github.com/jmendiara/lru-pcache)
41 | - [ ] abort fetch & xhr
42 |
43 | ## License
44 |
45 | MIT
46 |
--------------------------------------------------------------------------------
/scripts/check-dist-tag.js:
--------------------------------------------------------------------------------
1 | #! /usr/bin/env node
2 | const chalk = require('chalk');
3 | const { isMasterBranch, getCurrentBranchName } = require('./utils');
4 |
5 | const distTag = process.env.npm_config_tag || 'latest';
6 |
7 | if (isMasterBranch(getCurrentBranchName())) {
8 | if (distTag !== 'latest') {
9 | console.log(chalk.red('你只能在此分支发布正式版，而不是', distTag));
10 | process.exit(1);
11 | }
12 | } else if (distTag === 'latest') {
13 | console.log(chalk.red('你不能在此分支发布正式版，设置 --tag'));
14 | process.exit(1);
15 | }
16 |
--------------------------------------------------------------------------------
/scripts/check-version-bump.js:
--------------------------------------------------------------------------------
1 | #! /usr/bin/env node
2 | const semverParse = require('semver').parse;
3 | const chalk = require('chalk');
4 | const { isMasterBranch, getCurrentBranchName } = require('./utils');
5 |
6 | // npm 5、6: undefined new
7 | // npm 7: new old
8 | // console.log(process.env.npm_new_version, process.env.npm_package_version);
9 | const newVersion = process.env.npm_new_version || process.env.npm_package_version;
10 | const prerelease = semverParse(newVersion)?.prerelease;
11 | // const perid = process.env.npm_config_perid;
12 | console.log(newVersion, prerelease);
13 |
14 | if (isMasterBranch(getCurrentBranchName())) {
15 | if (prerelease && prerelease.length > 0) {
16 | console.log(chalk.red('你不能在此分支发布测试版'));
17 | process.exit(1);
18 | }
19 | } else if (!prerelease || prerelease.length === 0) {
20 | console.log(chalk.red('你不能在此分支发布正式版'));
21 | process.exit(1);
22 | }
23 |
--------------------------------------------------------------------------------
/scripts/incremental-test.js:
--------------------------------------------------------------------------------
1 | // const { getCurrentBranchName } = require('./utils');
2 | const { execSync } = require('child_process');
3 |
4 | const stdout = execSync('git diff HEAD^ HEAD --name-only').toString().trim();
5 | const filenames = stdout.split('\n');
6 |
7 | console.log(filenames);
8 |
--------------------------------------------------------------------------------
/scripts/utils.js:
--------------------------------------------------------------------------------
1 | const { execSync } = require('child_process');
2 |
3 | const isMasterBranch = (branchName) => ['master','online', 'main', 'latest'].includes(branchName);
4 |
5 | // execSync('git rev-parse --abbrev-ref HEAD').toString().trim();
6 | exports.getCurrentBranchName = () => execSync('git branch --show-current').toString().trim();
7 | exports.isMasterBranch = isMasterBranch;
8 |
--------------------------------------------------------------------------------
/tsconfig.build.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "./tsconfig.json",
3 | "compilerOptions": {
4 | "declaration": true
5 | },
6 | "exclude": ["**/*.spec.tsx", "**/*.spec.ts", "**/*.test.tsx", "**/*.test.ts", "**/*/demo/**/*", "demo*.ts", "demo*.tsx"]
7 | // "exclude": ["**/*.{spec,test}.{ts,tsx}"]
8 | }
9 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "target": "esnext",
4 | "module": "esnext",
5 | "strict": true,
6 | "skipLibCheck": true,
7 | "noImplicitThis": true,
8 | "noImplicitAny": true,
9 | "noImplicitReturns": true,
10 | "jsx": "preserve",
11 | "importHelpers": true,
12 | "moduleResolution": "node",
13 | "esModuleInterop": true,
14 | "allowSyntheticDefaultImports": true,
15 | "baseUrl": ".",
16 | "paths": {
17 | "packages/*": ["packages/*"],
18 | "@/*": ["website/*"]
19 | },
20 | "lib": ["esnext", "dom", "dom.iterable"]
21 | },
22 | "include": ["packages/**/*.ts", "packages/**/*.tsx", "packages/**/*.vue", "typings/**/*"],
23 | "exclude": ["node_modules", "cjs", "es", "website"],
24 | "locale": "zh-CN"
25 | }
26 |
--------------------------------------------------------------------------------
/typings/css-module-shim.d.ts:
--------------------------------------------------------------------------------
1 | // import type { ComponentOptions, DefineComponent } from 'vue';
2 |
3 | declare module '*.module.scss' {
4 | const obj: Record;
5 | export default obj;
6 | }
7 |
--------------------------------------------------------------------------------
/typings/vue-shim.d.ts:
--------------------------------------------------------------------------------
1 | // import type { ComponentOptions, DefineComponent } from 'vue';
2 |
3 | declare module '*.vue' {
4 | import type { DefineComponent } from 'vue';
5 |
6 | const component: DefineComponent<{}, {}, any>;
7 | export default component;
8 | }
9 |
--------------------------------------------------------------------------------
/typings/vue-test-utils.d.ts:
--------------------------------------------------------------------------------
1 | import type { ComponentPublicInstance } from 'vue';
2 |
3 | declare module '@vue/test-utils' {
4 | interface DOMWrapper {
5 | style: CSSStyleDeclaration;
6 | }
7 |
8 | interface VueWrapper {
9 | style: CSSStyleDeclaration;
10 | }
11 | }
12 |
--------------------------------------------------------------------------------
/website/.vitepress/config.js:
--------------------------------------------------------------------------------
1 | require('sucrase/register/ts')
2 |
3 | const { config } = require('./config.ts')
4 |
5 | /**
6 | * @type {import('vitepress').UserConfig}
7 | */
8 | module.exports = config
9 |
--------------------------------------------------------------------------------
/website/.vitepress/config.ts:
--------------------------------------------------------------------------------
1 | import MarkdownIt from 'markdown-it';
2 | import { UserConfig } from 'vitepress';
3 | import markdownItCheckbox from 'markdown-it-checkbox';
4 | import markdownItDemo from './markdown/plugin/markdown-it-demo';
5 | const fs = require('fs-extra');
6 | const path = require('path');
7 |
8 | const INPUT_PATH = path.resolve(__dirname, '../../packages');
9 |
10 | export const config: UserConfig = {
11 | base: '/async-utilities/',
12 | title: 'Async Utilities',
13 | lang: 'zh-CN',
14 | description: process.env.npm_package_description,
15 |
16 | // https://vitepress.vuejs.org/guide/markdown.html#advanced-configuration
17 | markdown: {
18 | lineNumbers: true,
19 | config: (md: MarkdownIt) => {
20 | md.use(markdownItCheckbox);
21 | md.use(markdownItDemo);
22 | },
23 | },
24 |
25 | themeConfig: {
26 | sidebar: {
27 | // '/functions/': getComponentsSidebar(),
28 | // '/guide/': getGuideSidebar(),
29 | '/': getComponentsSidebar(),
30 | },
31 | nav: [
32 | { text: '指南 Guide', link: '/', activeMatch: '^/$|^/guide/' },
33 | {
34 | text: '函数 Functions',
35 | link: '/functions/abortableAsync/readme',
36 | activeMatch: '^/functions/',
37 | },
38 | {
39 | text: 'Github',
40 | link: 'https://github.com/bowencool/async-utilities',
41 | },
42 | ],
43 | },
44 | };
45 |
46 | function getComponentsSidebar() {
47 | let functions = [];
48 | fs.readdirSync(`${INPUT_PATH}`)
49 | .filter((name) => !name.includes('.'))
50 | .forEach((name) => {
51 | // console.log(name)
52 | // return;
53 | let mdFile = `readme.md`;
54 | // console.log(name, mdFile);
55 | if (fs.existsSync(`${INPUT_PATH}/${name}/${mdFile}`)) {
56 | const text = name.replace(/[-_]([a-z])/g, (_, $1) => $1.toUpperCase());
57 | const link = `/functions/${name}/${mdFile.replace(/\.md$/, '')}`;
58 | functions.push({
59 | text,
60 | link,
61 | });
62 | }
63 | });
64 | // console.log(functions);
65 | // return functions;
66 | return [
67 | {
68 | text: '介绍 Intro',
69 | children: [
70 | { text: '开始使用 Getting started', link: '/guide/getting-started' },
71 | // { text: '配置', link: '/guide/configuration' },
72 | // { text: '贡献/开发指南', link: '/guide/contribution' },
73 | // { text: 'Todos', link: '/guide/todos' },
74 | ],
75 | },
76 | {
77 | text: '函数 Functions',
78 | children: functions,
79 | },
80 | ];
81 | }
82 |
--------------------------------------------------------------------------------
/website/.vitepress/markdown/plugin/build-demos.vite.config.ts:
--------------------------------------------------------------------------------
1 | import vue from '@vitejs/plugin-vue';
2 | import { mergeConfig, UserConfig } from 'vite';
3 | // 复用配置
4 | import config from '../../../vite.config';
5 | import { readFileSync } from 'fs';
6 | import { resolve } from 'path';
7 | import type { IframeMeta } from './genIframe';
8 | import { genHtml } from './genIframe';
9 | import { config as vitepressConfig } from '../../config';
10 |
11 | // 我不知道 markdown-it-plugin 怎么跟 vite-plugin 低成本取得联系，所以直接通过文件传参了。这个文件是 markdown-it-demo 生成的。
12 | const demos: Record = JSON.parse(
13 | readFileSync(resolve(process.cwd(), 'node_modules/demos.json'), 'utf-8'),
14 | );
15 |
16 | // 虚拟的目录名，和 devServer 保持一致
17 | const dir = resolve(process.cwd(), '-demos');
18 |
19 | const iframeConfig: UserConfig = {
20 | plugins: [
21 | // 复用配置了，但是原本的配置里没写，所以这里添加了
22 | vue(),
23 | // todo 合并
24 | {
25 | name: 'demo-iframe-build',
26 | resolveId(id) {
27 | if (id.match(/\/-demos\/(\w+)\.html/)) {
28 | return id;
29 | }
30 | return undefined;
31 | },
32 | load(id) {
33 | if (id.match(/\/-demos\/(\w+)\.html/)) {
34 | const demoName = RegExp.$1;
35 | const meta = demos[demoName];
36 | if (meta) {
37 | meta.title = meta.title || demoName;
38 | return genHtml(meta);
39 | }
40 | }
41 | return undefined;
42 | },
43 | },
44 | ],
45 | base: vitepressConfig.base,
46 | build: {
47 | // 为了方便，目录选择了 vitepress 的目录
48 | outDir: 'website/.vitepress/dist',
49 | emptyOutDir: false,
50 | rollupOptions: {
51 | input: {},
52 | },
53 | },
54 | };
55 |
56 | const input = iframeConfig.build.rollupOptions.input;
57 |
58 | // 添加所有入口
59 | Object.entries(demos).forEach(([demoName, meta]) => {
60 | const htmlEntry = `${dir}/${demoName}.html`;
61 | if (Array.isArray(input)) {
62 | input.push(htmlEntry);
63 | } else {
64 | input[demoName] = htmlEntry;
65 | }
66 | });
67 |
68 | export default mergeConfig(config, iframeConfig);
69 |
--------------------------------------------------------------------------------
/website/.vitepress/markdown/plugin/genIframe.ts:
--------------------------------------------------------------------------------
1 | import { resolve } from 'path';
2 |
3 | export type IframeMeta = {
4 | title?: string;
5 | entry: string;
6 | };
7 | const autoEntry = (entry: string) => {
8 | if (process.env.NODE_ENV === 'development') {
9 | return `/@fs/${entry}`;
10 | }
11 | return entry;
12 | };
13 | export const genHtml = (meta: IframeMeta) => {
14 | const customCss = resolve(process.cwd(), 'website/.vitepress/theme/custom.scss');
15 | const devTip = (process.env.NODE_ENV === 'development'
16 | ? `console.log('iframe 模式自动挂载了一个vue组件：%o', module.default.__file || module.default);console.log('如果你不希望自动挂载，移除 export default');`
17 | : '');
18 | return `
19 |
20 |
21 |
22 |
23 |
24 | ${meta.title}
25 |
26 |
27 |
28 |
29 |
43 |
44 | `;
45 | };
46 |
--------------------------------------------------------------------------------
/website/.vitepress/markdown/plugin/markdown-it-demo.ts:
--------------------------------------------------------------------------------
1 | import mdContainer from 'markdown-it-container';
2 | import MarkdownIt from 'markdown-it';
3 | import path from 'path';
4 | import fs from 'fs';
5 | // import md5 from 'md5';
6 | import { highlight } from 'vitepress/dist/node/serve-9731a371.js';
7 | import { config as vitepressConfig } from '../../config';
8 |
9 | let count = 1001;
10 | const scriptSetupRE = /<\s*script[^>]*\bsetup\b[^>]*/;
11 | // const attrRE = /\b(?\w+)=("|')(?[^\2]*)\2/g;
12 | const attrRE = /\b(?\w+)(="(?[^"]*)")?/g;
13 | const demoContainer = 'DemoContainer';
14 |
15 | /** 解析 a="1" b="2" 这种格式的字符串，返回一个对象 */
16 | function parseAttrs(attrs: string) {
17 | const meta = {};
18 | let rez = null;
19 | while ((rez = attrRE.exec(attrs))) {
20 | const { key, value } = rez.groups;
21 | const newValue = value === void 0 ? true : value;
22 | if (Array.isArray(meta[key])) {
23 | meta[key].push(newValue);
24 | } else if (!meta[key]) {
25 | meta[key] = newValue;
26 | } else {
27 | meta[key] = [meta[key], newValue];
28 | }
29 | }
30 | return meta;
31 | }
32 |
33 | /** 在script里添加组件引入语句 */
34 | function addImportDeclaration(hoistedTags, localName: string, source: string) {
35 | const existingScriptIndex = hoistedTags.findIndex((tag) => {
36 | return scriptSetupRE.test(tag);
37 | });
38 | if (existingScriptIndex === -1) {
39 | hoistedTags.push(``);
40 | } else {
41 | hoistedTags[existingScriptIndex] = hoistedTags[existingScriptIndex].replace(
42 | /<\/script>/,
43 | `\nimport ${localName} from '${source}';\n`,
44 | );
45 | }
46 | }
47 |
48 | /** 在script里添加变量声明语句 */
49 | function addVariableDeclaration(hoistedTags, localName: string, express: string) {
50 | const existingScriptIndex = hoistedTags.findIndex((tag) => {
51 | return scriptSetupRE.test(tag);
52 | });
53 | if (existingScriptIndex === -1) {
54 | hoistedTags.push(``);
55 | } else {
56 | hoistedTags[existingScriptIndex] = hoistedTags[existingScriptIndex].replace(
57 | /<\/script>/,
58 | `\nconst ${localName} = ${express};\n`,
59 | );
60 | }
61 | }
62 |
63 | type FileDTO = {
64 | filePath: string;
65 | codeStr: string;
66 | htmlStr?: string;
67 | language: string;
68 | };
69 |
70 | /** 读取文件内容，返回统一格式。如果文件不存在，智能推测文件名，如果没有推测出来，返回null */
71 | function resolveFile(absolutePath): FileDTO | null {
72 | // console.log(absolutePath);
73 | if (!absolutePath) return null;
74 | let filePath = absolutePath;
75 |
76 | if (!fs.existsSync(filePath)) {
77 | // 推测 absolutePath
78 | const extensions = ['.ts', '.tsx', '.vue', '.html'];
79 | for (const ext of extensions) {
80 | filePath = absolutePath + ext;
81 | if (fs.existsSync(filePath)) {
82 | break;
83 | }
84 | }
85 | }
86 | if (!fs.existsSync(filePath)) return null;
87 | const rawContent = fs.readFileSync(filePath, 'utf-8');
88 |
89 | const language = filePath.match(/\.(\w+)$/)?.[1];
90 | return {
91 | filePath,
92 | codeStr: encodeURIComponent(rawContent),
93 | language,
94 | htmlStr: encodeURIComponent(highlight(rawContent, language)),
95 | };
96 | }
97 |
98 | const demos = {};
99 | /** 将demo信息拼接成 html(vue template) 字符串 */
100 | function genDemo(meta, md: MarkdownIt) {
101 | // @ts-ignore
102 | const { __path, __data: data } = md;
103 | const hoistedTags = data.hoistedTags || (data.hoistedTags = []);
104 | // console.log('meta: ', meta);
105 | let htmlOpenString = `<${demoContainer}`;
106 | // ${errorStr}`;
125 | // return { htmlOpenString };
126 | }
127 | const currentDir = path.dirname(__path);
128 | let absolutePath = path.resolve(currentDir, meta.src);
129 | const srcFile = resolveFile(absolutePath);
130 | if (meta.language) {
131 | srcFile.language = meta.language;
132 | }
133 |
134 | if (!srcFile) {
135 | let errorStr = `NotFound: file not found\n\t${meta.src}`;
136 | throw new Error(errorStr);
137 | // attrsStr += ` codeStr="${encodeURIComponent(errorStr)}"`;
138 | // htmlOpenString += ` ${attrsStr}>${errorStr}`;
139 | } else {
140 | const metaFiles = Array.isArray(meta.file) ? meta.file : [meta.file].filter(Boolean);
141 |
142 | const files = [srcFile, ...metaFiles.map((p) => resolveFile(path.resolve(currentDir, p)))]
143 | .filter((f, i, a) => {
144 | // console.log('filter', f);
145 | if (!f) return false;
146 | return a.findIndex((f2) => f2.filePath === f.filePath) === i;
147 | })
148 | .map((f) => ({ ...f, name: path.relative(currentDir, f.filePath) }));
149 | // todo const localName = 'Demo' + md5(srcFile.filePath);
150 | const localName = `Demo${++count}`;
151 | const varName = `files${count}`;
152 | addVariableDeclaration(hoistedTags, varName, JSON.stringify(files));
153 | const filesAttr = ` :files="${varName}"`;
154 | attrsStr += filesAttr;
155 |
156 | let useIframeMode = meta.iframe || absolutePath.endsWith('.html');
157 | if (useIframeMode) {
158 | // const isSymbolicLink = fs.lstatSync(absolutePath).isSymbolicLink()
159 | attrsStr += ` iframe`;
160 | demos[localName] = { title: meta.title, entry: absolutePath };
161 | fs.writeFileSync(path.resolve(process.cwd(), 'node_modules/demos.json'), JSON.stringify(demos, null, 2));
162 | htmlOpenString += ` ${attrsStr}>