feat: add query-string

Carrotzpc · May 15, 2024 · 5d4f829 · 5d4f829
1 parent 533d90e
commit 5d4f829
Show file tree

Hide file tree

Showing 8 changed files with 273 additions and 0 deletions.
diff --git a/packages/index.md b/packages/index.md
@@ -0,0 +1,3 @@
+# packages
+
+- [@umdjs/query-string](/packages/query-string)
diff --git a/packages/query-string/.fatherrc.ts b/packages/query-string/.fatherrc.ts
@@ -0,0 +1,25 @@
+import { defineConfig } from 'father';
+
+const library = 'queryString';
+
+const externals = {
+  //
+};
+
+export default defineConfig({
+  umd: {
+    entry: {
+      'src/index.ts': {
+        name: library,
+        // 拆解 default
+        chainWebpack: memo => {
+          memo.output.libraryExport('default');
+          return memo;
+        },
+        sourcemap: true,
+        externals,
+      },
+    },
+    output: 'dist',
+  },
+});
diff --git a/packages/query-string/README.md b/packages/query-string/README.md
@@ -0,0 +1,166 @@
+<a name="readme-top"></a>
+
+<div align="center">
+
+<h1>@umdjs/query-string</h1>
+
+UMD build dist for [query-string][query-string-npm-link].
+
+English ・ [简体中文](./README.zh-CN.md) ・ [Changelog](./CHANGELOG.md) · [Report Bug][github-issues-link] · [Request Feature][github-issues-link]
+
+<!-- SHIELD GROUP -->
+
+[![][npm-release-shield]][npm-release-link]
+
+<!-- [![][vercel-shield]][vercel-link] -->
+
+[![][npm-downloads-shield]][npm-downloads-link]
+[![][github-releasedate-shield]][github-releasedate-link]
+[![][github-action-test-shield]][github-action-test-link]
+[![codecov][codecov-shield]][codecov-link]<br/>
+[![][github-action-release-shield]][github-action-release-link]
+[![][github-contributors-shield]][github-contributors-link]
+[![][github-forks-shield]][github-forks-link]
+[![][github-stars-shield]][github-stars-link]
+[![][github-issues-shield]][github-issues-link]
+[![][github-license-shield]][github-license-link]
+
+<!-- [![][banner]][vercel-link] -->
+
+</div>
+
+## 📦 Usage
+
+> \[!NOTE]\
+> The @umdjs/query-string only provides UMD dist of [query-string][query-string-npm-link].
+
+Add `script` tag in your browser and use the global variable **`queryString`**.
+
+We provide dist files under [dist](https://unpkg.com/browse/@umdjs/query-string/dist/) folder in @umdjs/query-string's npm package. You can also download these files directly from [![][query-string-jsdelivr-data-link]][query-string-jsdelivr-link] or [unpkg][query-string-unpkg-link].
+
+```html
+<!doctype html>
+<html lang="zh-CN">
+  <head>
+    <script src="//unpkg.com/@umdjs/query-string/dist/index.min.js" />
+  </head>
+  <body>
+    <script>
+      console.log(location.search);
+      //=> '?foo=bar'
+
+      // ~ Use `queryString` from global:
+      const parsed = queryString.parse(location.search);
+      console.log(parsed);
+      //=> {foo: 'bar'}
+
+      console.log(location.hash);
+      //=> '#token=bada55cafe'
+
+      const parsedHash = queryString.parse(location.hash);
+      console.log(parsedHash);
+      //=> {token: 'bada55cafe'}
+
+      parsed.foo = 'unicorn';
+      parsed.ilike = 'pizza';
+
+      const stringified = queryString.stringify(parsed);
+      //=> 'foo=unicorn&ilike=pizza'
+
+      location.search = stringified;
+      // note that `location.search` automatically prepends a question mark
+      console.log(location.search);
+      //=> '?foo=unicorn&ilike=pizza'
+    </script>
+  </body>
+</html>
+```
+
+<div align="right">
+
+[![][back-to-top]](#readme-top)
+
+</div>
+
+## ⌨️ Local Development
+
+You can use Github Codespaces for online development:
+
+[![][codespaces-shield]][codespaces-link]
+
+Or clone it for local development:
+
+```bash
+git clone https://github.com/Carrotzpc/umdjs.git
+cd umdjs
+pnpm install
+pnpm dev
+```
+
+<div align="right">
+
+[![][back-to-top]](#readme-top)
+
+</div>
+
+## 🗒️ Changelog
+
+See [query-string/CHANGELOG.md][changelog-link] for detail.
+
+## 🤝 Contributing
+
+Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub [Issues][github-issues-link] to get stuck in to show us what you’re made of.
+
+[![][pr-welcome-shield]][pr-welcome-link]
+
+[![][contributors-contrib]][contributors-link]
+
+---
+
+#### 📝 License
+
+Copyright © 2024 [Carrotzpc][profile-link]. <br />
+This project is MIT licensed.
+
+<div align="right">
+
+[![][back-to-top]](#readme-top)
+
+</div>
+<!-- LINK GROUP -->
+
+[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square
+[changelog-link]: https://github.com/Carrotzpc/umdjs/packages/query-string/CHANGELOG.md
+[codecov-link]: https://codecov.io/gh/Carrotzpc/umdjs
+[codecov-shield]: https://img.shields.io/codecov/c/github/Carrotzpc/umdjs?token=XVQEXR75U4&style=flat-square&logo=Codecov&logoColor=white&labelColor=black&color=4c1
+[codespaces-link]: https://codespaces.new/Carrotzpc/umdjs
+[codespaces-shield]: https://github.com/codespaces/badge.svg
+[contributors-contrib]: https://contrib.rocks/image?repo=Carrotzpc/umdjs
+[contributors-link]: https://github.com/Carrotzpc/umdjs/graphs/contributors
+[github-action-release-link]: https://github.com/actions/workflows/Carrotzpc/umdjs/release.yml
+[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/Carrotzpc/umdjs/release.yml?label=release&labelColor=black&logo=semanticrelease&logoColor=white&style=flat-square
+[github-action-test-link]: https://github.com/actions/workflows/Carrotzpc/umdjs/test.yml
+[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/Carrotzpc/umdjs/test.yml?label=test&labelColor=black&logo=jest&logoColor=white&style=flat-square
+[github-contributors-link]: https://github.com/Carrotzpc/umdjs/graphs/contributors
+[github-contributors-shield]: https://img.shields.io/github/contributors/Carrotzpc/umdjs?color=c4f042&labelColor=black&style=flat-square
+[github-forks-link]: https://github.com/Carrotzpc/umdjs/network/members
+[github-forks-shield]: https://img.shields.io/github/forks/Carrotzpc/umdjs?color=8ae8ff&labelColor=black&style=flat-square
+[github-issues-link]: https://github.com/Carrotzpc/umdjs/issues
+[github-issues-shield]: https://img.shields.io/github/issues/Carrotzpc/umdjs?color=ff80eb&labelColor=black&style=flat-square
+[github-license-link]: https://github.com/Carrotzpc/umdjs/blob/master/LICENSE
+[github-license-shield]: https://img.shields.io/github/license/Carrotzpc/umdjs?color=white&labelColor=black&style=flat-square
+[github-releasedate-link]: https://github.com/Carrotzpc/umdjs/releases
+[github-releasedate-shield]: https://img.shields.io/github/release-date/Carrotzpc/umdjs?labelColor=black&style=flat-square
+[github-stars-link]: https://github.com/Carrotzpc/umdjs/network/stargazers
+[github-stars-shield]: https://img.shields.io/github/stars/Carrotzpc/umdjs?color=ffcb47&labelColor=black&style=flat-square
+[npm-downloads-link]: https://www.npmjs.com/package/@umdjs/query-string
+[npm-downloads-shield]: https://img.shields.io/npm/dt/@umdjs/query-string?labelColor=black&style=flat-square
+[npm-release-link]: https://www.npmjs.com/package/@umdjs/query-string
+[npm-release-shield]: https://img.shields.io/npm/v/@umdjs/query-string?color=369eff&labelColor=black&logo=npm&logoColor=white&style=flat-square
+[pr-welcome-link]: https://github.com/Carrotzpc/umdjs/pulls
+[pr-welcome-shield]: https://img.shields.io/badge/🥕_pr_welcome-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge
+[profile-link]: https://github.com/Carrotzpc
+[query-string-jsdelivr-data-link]: https://data.jsdelivr.com/v1/package/npm/@umdjs/query-string
+[query-string-jsdelivr-link]: https://www.jsdelivr.com/package/npm/@umdjs/query-string
+[query-string-npm-link]: https://www.npmjs.com/package/query-string
+[query-string-unpkg-link]: https://unpkg.com/@umdjs/query-string/dist
diff --git a/packages/query-string/index.md b/packages/query-string/index.md
@@ -0,0 +1,5 @@
+---
+title: query-string
+---
+
+<embed src="./README.md"></embed>
diff --git a/packages/query-string/jest.config.ts b/packages/query-string/jest.config.ts
@@ -0,0 +1,7 @@
+import { Config, createConfig } from '@umijs/test';
+
+export default {
+  ...createConfig(),
+  collectCoverageFrom: ['src/**/*.{ts,js,tsx,jsx}'],
+  coveragePathIgnorePatterns: ['src/types.d.ts'],
+} as Config.InitialOptions;
diff --git a/packages/query-string/package.json b/packages/query-string/package.json
@@ -0,0 +1,37 @@
+{
+  "name": "@umdjs/query-string",
+  "version": "1.0.0-beta.1",
+  "description": "UMD build dist for query-string.",
+  "keywords": [
+    "UMD",
+    "query-string"
+  ],
+  "homepage": "https://yuntijs.github.io/lowcode-tools/packages/lowcode-i18n-extract",
+  "bugs": {
+    "url": "https://github.com/Carrotzpc/umdjs/issues/new"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Carrotzpc/umdjs.git"
+  },
+  "license": "MIT",
+  "files": [
+    "dist",
+    "compiled"
+  ],
+  "scripts": {
+    "build": "father build",
+    "build:deps": "father prebundle",
+    "dev": "cross-env NODE_ENV=development father dev",
+    "prepublishOnly": "father doctor && npm run build",
+    "test": "jest",
+    "test:cov": "jest --collectCoverage"
+  },
+  "dependencies": {
+    "query-string": "^9.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
+}
diff --git a/packages/query-string/src/index.ts b/packages/query-string/src/index.ts
@@ -0,0 +1 @@
+export { default } from 'query-string';
diff --git a/packages/query-string/tsconfig.json b/packages/query-string/tsconfig.json
@@ -0,0 +1,29 @@
+{
+  "buildOnSave": false,
+  "compileOnSave": false,
+  "compilerOptions": {
+    "baseUrl": ".",
+    "declaration": true,
+    "outDir": "build",
+    "module": "esnext",
+    "target": "es6",
+    "jsx": "react",
+    "moduleResolution": "node",
+    "lib": ["es6", "dom"],
+    "paths": {
+      "@yuntijs/lowcode-i18n-extract": ["src"],
+      "@yuntijs/lowcode-i18n-extract/*": ["src/*"]
+    },
+    "sourceMap": true,
+    "allowJs": true,
+    "noUnusedLocals": true,
+    "noImplicitReturns": true,
+    "noImplicitThis": true,
+    "noImplicitAny": true,
+    "skipLibCheck": true,
+    "allowSyntheticDefaultImports": true,
+    "resolveJsonModule": true
+  },
+  "exclude": ["node_modules", "build", "public"],
+  "include": ["src/*.ts", "src/*.tsx", "demo/*.tsx"]
+}