Merge pull request #4 from JOU-amjs/feature-1.0.x

refactor: change name sdm to sdm2

Author: JOU-amjs

.github/ISSUE_TEMPLATE/BUG_REPORT_en.yml

@@ -14,7 +14,7 @@ body:
   - type: input
     id: version
     attributes:
-      label: sdm Version
+      label: sdm2 Version
       description: Please fill in the version actually installed in node_modules/@alova/adapter-uniapp/package.json
       placeholder: E.g. 1.4.0
     validations:

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 sdmjs
+Copyright (c) 2023 sdm2js
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,8 +1,8 @@
-# [sdm](https://github.com/JOU-amjs/msd)
+# [sdm2](https://github.com/JOU-amjs/msd)
 
-[![npm](https://img.shields.io/npm/v/sdm)](https://www.npmjs.com/package/sdm)
-![size](https://img.shields.io/bundlephobia/min/sdm)
-[![Coverage Status](https://coveralls.io/repos/github/JOU-amjs/sdm/badge.svg)](https://coveralls.io/github/JOU-amjs/sdm)
+[![npm](https://img.shields.io/npm/v/sdm2)](https://www.npmjs.com/package/sdm2)
+![size](https://img.shields.io/bundlephobia/min/sdm2)
+[![Coverage Status](https://coveralls.io/repos/github/JOU-amjs/sdm2/badge.svg)](https://coveralls.io/github/JOU-amjs/sdm2)
 ![typescript](https://badgen.net/badge/icon/typescript?icon=typescript&label)
 ![license](https://img.shields.io/badge/license-MIT-blue.svg)
 
@@ -20,26 +20,26 @@
 
 ```bash
 # via npm
-npm install sdm
+npm install sdm2
 
 #via yarn
-yarn add sdm
+yarn add sdm2
 ```
 
 Introduced in `Node.js`, `esModule`, `Browser`
 
 ```javascript
 // commonjs(Node.js)
-var { match, filterMap } = require('sdm').default;
+var { match, filterMap } = require('sdm2').default;
 
 // esModule
-import { match, filterMap } from 'sdm';
+import { match, filterMap } from 'sdm2';
 ```
 
 Browser
 
 ```html
-<script src="https://unpkg.com/sdm"></script>
+<script src="https://unpkg.com/sdm2"></script>
 ```
 
 ## **Usage**
@@ -97,7 +97,7 @@ const ret = match({ name: 'src/views/home.jsx' }, 'shojsx', {
 When we search for key characters, we always want to highlight the matching key characters, so we also provide a helper function to help you do it.
 
 ```javascript
-import { match } from 'sdm';
+import { match } from 'sdm2';
 const ret = match('src/views/home.jsx', 'shojsx', {
 	onMatched: (matchedStr, originStr) => `<span class="highlight">${matchedStr}</span>`
 });
@@ -115,7 +115,7 @@ const ret = match('src/views/home.jsx', 'shojsx', {
 If it is an array of strings, we can use `filterMap` to filter and convert strings at the same time.
 
 ```javascript
-import { filterMap } from 'sdm';
+import { filterMap } from 'sdm2';
 
 const matchedStrings = ['src/views/home.jsx', 'src/views/about.jsx', 'src/views/ad.jsx'];
 const ret = filterMap(matchedStrings, 'shojsx', (matchedInfo, index) => matchedInfo.str, {
@@ -143,7 +143,7 @@ The key string is a 50-digit random string
 
 ## **SUBMIT A QUESTION**
 
-- [Click here to submit](https://github.com/JOU-amjs/sdm/issues)
+- [Click here to submit](https://github.com/JOU-amjs/sdm2/issues)
 
 ## LICENSE MIT
 

README.zh-CN.md

@@ -1,8 +1,8 @@
-# [sdm](https://github.com/JOU-amjs/msd)
+# [sdm2](https://github.com/JOU-amjs/msd)
 
-[![npm](https://img.shields.io/npm/v/sdm)](https://www.npmjs.com/package/sdm)
-![size](https://img.shields.io/bundlephobia/min/sdm)
-[![Coverage Status](https://coveralls.io/repos/github/JOU-amjs/sdm/badge.svg)](https://coveralls.io/github/JOU-amjs/sdm)
+[![npm](https://img.shields.io/npm/v/sdm2)](https://www.npmjs.com/package/sdm2)
+![size](https://img.shields.io/bundlephobia/min/sdm2)
+[![Coverage Status](https://coveralls.io/repos/github/JOU-amjs/sdm2/badge.svg)](https://coveralls.io/github/JOU-amjs/sdm2)
 ![typescript](https://badgen.net/badge/icon/typescript?icon=typescript&label)
 ![license](https://img.shields.io/badge/license-MIT-blue.svg)
 
@@ -20,26 +20,26 @@
 
 ```bash
 # via npm
-npm install sdm
+npm install sdm2
 
 # via yarn
-yarn add sdm
+yarn add sdm2
 ```
 
 在`Node.js`, `esModule`, `Browser`引入
 
 ```javascript
 // commonjs(Node.js)
-var { match, filterMap } = require('sdm').default;
+var { match, filterMap } = require('sdm2').default;
 
 // esModule
-import { match, filterMap } from 'sdm';
+import { match, filterMap } from 'sdm2';
 ```
 
 Browser
 
 ```html
-<script src="https://unpkg.com/sdm"></script>
+<script src="https://unpkg.com/sdm2"></script>
 ```
 
 ## **用法**
@@ -97,7 +97,7 @@ const ret = match({ name: 'src/views/home.jsx' }, 'shojsx', {
 我们在搜索关键字符时，总是希望高亮匹配到的关键字符，因此我们还提供了一个辅助函数帮助你完成它。
 
 ```javascript
-import { match } from 'sdm';
+import { match } from 'sdm2';
 const ret = match('src/views/home.jsx', 'shojsx', {
 	onMatched: (matchedStr, originStr) => `<span class="highlight">${matchedStr}</span>`
 });
@@ -115,7 +115,7 @@ const ret = match('src/views/home.jsx', 'shojsx', {
 如果对于字符串数组，我们可以使用`filterMap`同时进行过滤和转换字符串。
 
 ```javascript
-import { filterMap } from 'sdm';
+import { filterMap } from 'sdm2';
 
 const matchedStrings = ['src/views/home.jsx', 'src/views/about.jsx', 'src/views/ad.jsx'];
 const ret = filterMap(matchedStrings, 'shojsx', (matchedInfo, index) => matchedInfo.str, {
@@ -147,4 +147,4 @@ Copyright (c) 2021 JOU. Copyright of the Typescript bindings are respective of e
 
 ### **提交一个问题**
 
-- [点此提交](https://github.com/JOU-amjs/sdm/issues)
+- [点此提交](https://github.com/JOU-amjs/sdm2/issues)

SECURITY.md

@@ -1,13 +1,13 @@
 # Security report
 
-Your reviews and reports on the security of `sdm` are very welcome.
+Your reviews and reports on the security of `sdm2` are very welcome.
 
-- Find existing security reports: Search existing security reports in [Github security channel](https://github.com/JOU-amjs/sdm/discussions/categories/security) to avoid duplicating work.
-- Reporting Security Issues: If you find a vulnerability, please report it in [Github security channel](https://github.com/JOU-amjs/sdm/discussions/categories/security). Our team of maintainers will respond and resolve it as quickly as possible.
+- Find existing security reports: Search existing security reports in [Github security channel](https://github.com/JOU-amjs/sdm2/discussions/categories/security) to avoid duplicating work.
+- Reporting Security Issues: If you find a vulnerability, please report it in [Github security channel](https://github.com/JOU-amjs/sdm2/discussions/categories/security). Our team of maintainers will respond and resolve it as quickly as possible.
 
 - Avoid Disclosing Sensitive Information: When reporting a security issue, make sure not to disclose any sensitive information in public, such as passwords, API keys, or personally identifiable information.
   Test environment: When testing, make sure you don't have any impact on the production environment.
 
 - Respect and Preserve the Community: Our community is built on mutual respect and cooperation. Please ensure that your actions comply with the community guidelines and ethical standards.
 
-We greatly appreciate your interest and contributions to the security of `sdm`. Your help will help us create a safer and healthier open source ecosystem.
+We greatly appreciate your interest and contributions to the security of `sdm2`. Your help will help us create a safer and healthier open source ecosystem.

commitlint.config.cjs

@@ -1,3 +1,3 @@
 module.exports = {
-  extends: ['@commitlint/config-conventional']
+	extends: ['@commitlint/config-conventional']
 };

config/rollup.cjs

@@ -5,15 +5,15 @@
  */
 var typescript = require('rollup-plugin-typescript2');
 const getCompiler = (
-  opt = {
-    // objectHashIgnoreUnknownHack: true,
-    // clean: true,
-    tsconfigOverride: {
-      compilerOptions: {
-        module: 'ES2015'
-      }
-    }
-  }
+	opt = {
+		// objectHashIgnoreUnknownHack: true,
+		// clean: true,
+		tsconfigOverride: {
+			compilerOptions: {
+				module: 'ES2015'
+			}
+		}
+	}
 ) => typescript(opt);
 exports.getCompiler = getCompiler;
 
@@ -29,8 +29,8 @@ exports.banner = `/**
 `;
 
 const compilePath = (exports.compilePath = {
-  packageName: 'sdm',
-  input: 'src/index.ts',
-  output: suffix => `dist/sdm.${suffix}.js`
+	packageName: 'sdm2',
+	input: 'src/index.ts',
+	output: suffix => `dist/sdm2.${suffix}.js`
 });
 exports.external = compilePath.external || [];

package.json

@@ -1,12 +1,12 @@
 {
-	"name": "sdm",
+	"name": "sdm2",
 	"version": "1.0.0",
 	"description": "A high performance librray to match discontinuous strings",
-	"main": "dist/sdm.js",
+	"main": "dist/sdm2.js",
 	"types": "typings/index.d.ts",
-	"module": "dist/sdm.esm.js",
-	"unpkg": "dist/sdm.umd.js",
-	"jsdelivr": "dist/sdm.umd.js",
+	"module": "dist/sdm2.esm.js",
+	"unpkg": "dist/sdm2.umd.js",
+	"jsdelivr": "dist/sdm2.umd.js",
 	"type": "module",
 	"scripts": {
 		"clean": "rimraf ./dist",
@@ -21,17 +21,18 @@
 		"build": "npm run clean && npm run build:esm && npm run build:umd && npm run build:umd.min",
 		"coveralls": "npm run test:coverage && coveralls < coverage/lcov.info",
 		"generate": "node generate-test-data.js 1000",
+		"aa": "cross-env VERSION=1.1.2 npm run build",
 		"commit": "git-cz && git push"
 	},
 	"author": "JOU-amjs",
 	"license": "MIT",
-	"homepage": "https://github.com/JOU-amjs/sdm#readme",
+	"homepage": "https://github.com/JOU-amjs/sdm2#readme",
 	"repository": {
 		"type": "git",
-		"url": "git://github.com/JOU-amjs/sdm.git"
+		"url": "git://github.com/JOU-amjs/sdm2.git"
 	},
 	"bugs": {
-		"url": "https://github.com/JOU-amjs/sdm/issues"
+		"url": "https://github.com/JOU-amjs/sdm2/issues"
 	},
 	"files": [
 		"/dist",
@@ -42,6 +43,7 @@
 		"match",
 		"strings search",
 		"string match",
+		"string discontinuous match",
 		"discontinuous match",
 		"search",
 		"discontinuous search"