feat: initail | docs | test

afeiship · afeiship · commit be6b8649f2c6 · 2020-11-23T10:06:46.000+08:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,11 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,12 @@
+node_modules
+bower_components
+coverage
+npm-debug.log
+yarn.lock
+package-lock.json
+.DS_Store
+.idea
+.vscode
+
+# vscode localhistory
+.history
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,25 @@
+.idea
+.DS_Store
+**/npm-debug.log
+**/node_modules
+test
+__tests__
+src
+build
+docs
+gulpfile.js
+
+.editorconfig
+.prettierrc
+Gemfile
+jest.config.js
+LICENSE.txt
+Rakefile
+express.js
+.vscode
+.release-it.json
+
+
+# vscode localhistory
+.history
+.release-it.json
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1,2 @@
+sass_binary_site=https://npm.taobao.org/mirrors/node-sass/
+package-lock=false
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,36 @@
+{
+  "trailingComma": "none",
+  "arrowParens": "always",
+  "printWidth": 100,
+  "bracketSpacing": true,
+  "jsxBracketSameLine": true,
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true,
+  "overrides": [
+    {
+      "files": "*.scss",
+      "options": {
+        "trailingComma": "none",
+        "tabWidth": 2,
+        "parser": "scss"
+      }
+    },
+    {
+      "files": "*.json",
+      "options": {
+        "trailingComma": "none",
+        "tabWidth": 2,
+        "parser": "json"
+      }
+    },
+    {
+      "files": "*.md",
+      "options": {
+        "trailingComma": "none",
+        "tabWidth": 2,
+        "parser": "json"
+      }
+    }
+  ]
+}
diff --git a/.release-it.json b/.release-it.json
@@ -0,0 +1,17 @@
+{
+  "git": {
+    "requireCleanWorkingDir": false
+  },
+  "hooks": {
+    "after:init": [
+      "npm run test",
+      "t2k"
+    ],
+    "after:bump": [
+      "npm run build"
+    ]
+  },
+  "github": {
+    "release": true
+  }
+}
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 afei <1290657123@qq.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,35 @@
+# next-regex-index-of
+> JavaScript's String.indexOf() that allows for regular expressions.
+
+[![version][version-image]][version-url]
+[![license][license-image]][license-url]
+[![size][size-image]][size-url]
+[![download][download-image]][download-url]
+
+## installation
+```bash
+npm install -S @jswork/next-regex-index-of
+```
+
+## usage
+```js
+import '@jswork/next-regex-index-of';
+
+const str = `What's this? 这是什么？`;
+const res = nx.regexIndexOf(str, /[\u4e00-\u9fa5]/);    // -1
+```
+
+## license
+Code released under [the MIT license](https://github.com/afeiship/next-regex-index-of/blob/master/LICENSE.txt).
+
+[version-image]: https://img.shields.io/npm/v/@jswork/next-regex-index-of
+[version-url]: https://npmjs.org/package/@jswork/next-regex-index-of
+
+[license-image]: https://img.shields.io/npm/l/@jswork/next-regex-index-of
+[license-url]: https://github.com/afeiship/next-regex-index-of/blob/master/LICENSE.txt
+
+[size-image]: https://img.shields.io/bundlephobia/minzip/@jswork/next-regex-index-of
+[size-url]: https://github.com/afeiship/next-regex-index-of/blob/master/dist/next-regex-index-of.min.js
+
+[download-image]: https://img.shields.io/npm/dm/@jswork/next-regex-index-of
+[download-url]: https://www.npmjs.com/package/@jswork/next-regex-index-of
diff --git a/__tests__/index.spec.js b/__tests__/index.spec.js
@@ -0,0 +1,16 @@
+(function () {
+  require('../src');
+
+  describe('api.basic test', () => {
+    test('nx.regexIndexOf null string should return -1', () => {
+      const res = nx.regexIndexOf(null, /xx/);
+      expect(res).toBe(-1);
+    });
+
+    test('nx.regexIndexOf search /[\u4e00-\u9fa5]/', () => {
+      const str = `What's this? 这是什么？`;
+      const res = nx.regexIndexOf(str, /[\u4e00-\u9fa5]/);
+      expect(res).toBe(13);
+    });
+  });
+})();
diff --git a/build/clean.js b/build/clean.js
@@ -0,0 +1,13 @@
+(function() {
+  'use strict';
+
+  const gulp = require('gulp');
+  const $ = require('gulp-load-plugins')({
+    pattern: ['gulp-*', 'gulp.*', 'del']
+  });
+
+  //clean
+  gulp.task('clean', function() {
+    return $.del('dist');
+  });
+})();
diff --git a/build/scripts.js b/build/scripts.js
@@ -0,0 +1,21 @@
+(function() {
+  'use strict';
+
+  const gulp = require('gulp');
+  const saveLicense = require('uglify-save-license');
+  const $ = require('gulp-load-plugins')({
+    pattern: ['gulp-*', 'gulp.*', 'del', '@jswork/gulp-*']
+  });
+
+  gulp.task('scripts', function() {
+    return gulp
+      .src('src/*.js')
+      .pipe($.jswork.pkgHeader())
+      .pipe(gulp.dest('dist'))
+      .pipe($.size({ title: '[ default size ]:' }))
+      .pipe($.uglify({ output: { comments: saveLicense } }))
+      .pipe($.rename({ extname: '.min.js' }))
+      .pipe(gulp.dest('dist'))
+      .pipe($.size({ title: '[ minimize size ]:' }));
+  });
+})();
diff --git a/dist/index.js b/dist/index.js
@@ -0,0 +1,25 @@
+/*!
+ * name: @jswork/next-regex-index-of
+ * description: JavaScript's String.indexOf() that allows for regular expressions.
+ * homepage: https://github.com/afeiship/next-regex-index-of
+ * version: 1.0.0
+ * date: 2020-11-23 10:06:34
+ * license: MIT
+ */
+
+(function () {
+  var global = global || this || window || Function('return this')();
+  var nx = global.nx || require('@jswork/next');
+  // https://stackoverflow.com/questions/273789/is-there-a-version-of-javascripts-string-indexof-that-allows-for-regular-expr
+
+  nx.regexIndexOf = function (inString, inRe, inStartPos) {
+    if (!inString) return -1;
+    var start = inStartPos || 0;
+    var idx = inString.substring(start).search(inRe);
+    return idx >= 0 ? idx + start : idx;
+  };
+
+  if (typeof module !== 'undefined' && module.exports) {
+    module.exports = nx.regexIndexOf;
+  }
+})();
diff --git a/dist/index.min.js b/dist/index.min.js
@@ -0,0 +1,9 @@
+/*!
+ * name: @jswork/next-regex-index-of
+ * description: JavaScript's String.indexOf() that allows for regular expressions.
+ * homepage: https://github.com/afeiship/next-regex-index-of
+ * version: 1.0.0
+ * date: 2020-11-23 10:06:34
+ * license: MIT
+ */
+!function(){var e=(this||window||Function("return this")()).nx||require("@jswork/next");e.regexIndexOf=function(e,n,r){if(!e)return-1;r=r||0,n=e.substring(r).search(n);return 0<=n?n+r:n},"undefined"!=typeof module&&module.exports&&(module.exports=e.regexIndexOf)}();
diff --git a/gulpfile.js b/gulpfile.js
@@ -0,0 +1,13 @@
+(function() {
+  'use strict';
+
+  const gulp = require('gulp');
+  const fs = require('fs');
+
+  //import
+  fs.readdirSync('./build').map(function(file) {
+    require('./build/' + file);
+  });
+
+  gulp.task('default', gulp.series(['clean', 'scripts']));
+})();
diff --git a/jest.config.js b/jest.config.js
@@ -0,0 +1,9 @@
+// https://jestjs.io/docs/en/configuration
+module.exports = {
+  verbose: true,
+  testRegex: [/\.spec.js/],
+  //preset: "jest-puppeteer",
+  moduleNameMapper: {
+    '^@/(.*)$': '<rootDir>/src/$1'
+  }
+};
diff --git a/package.json b/package.json
@@ -0,0 +1,40 @@
+{
+  "name": "@jswork/next-regex-index-of",
+  "version": "1.0.0",
+  "description": "JavaScript's String.indexOf() that allows for regular expressions.",
+  "homepage": "https://github.com/afeiship/next-regex-index-of",
+  "author": {
+    "name": "afei",
+    "email": "1290657123@qq.com"
+  },
+  "scripts": {
+    "build": "gulp",
+    "test": "jest",
+    "start": "node ./express.js",
+    "release": "release-it"
+  },
+  "main": "dist/index.js",
+  "license": "MIT",
+  "devDependencies": {
+    "@jswork/gulp-pkg-header": "^1.0.2",
+    "@jswork/next": "^1.0.2",
+    "del": "^6.0.0",
+    "gulp": "^4.0.2",
+    "gulp-debug": "^4.0.0",
+    "gulp-header": "^2.0.9",
+    "gulp-ignore": "^3.0.0",
+    "gulp-load-plugins": "^2.0.5",
+    "gulp-rename": "^2.0.0",
+    "gulp-size": "^3.0.0",
+    "gulp-uglify": "^3.0.2",
+    "jest": "^26.6.3",
+    "prettier": "^2.1.2",
+    "release-it": "^14.2.1",
+    "uglify-js": "3.11.6",
+    "uglify-save-license": "^0.4.1"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
+}
diff --git a/src/index.js b/src/index.js
@@ -0,0 +1,16 @@
+(function () {
+  var global = global || this || window || Function('return this')();
+  var nx = global.nx || require('@jswork/next');
+  // https://stackoverflow.com/questions/273789/is-there-a-version-of-javascripts-string-indexof-that-allows-for-regular-expr
+
+  nx.regexIndexOf = function (inString, inRe, inStartPos) {
+    if (!inString) return -1;
+    var start = inStartPos || 0;
+    var idx = inString.substring(start).search(inRe);
+    return idx >= 0 ? idx + start : idx;
+  };
+
+  if (typeof module !== 'undefined' && module.exports) {
+    module.exports = nx.regexIndexOf;
+  }
+})();

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+sass_binary_site=https://npm.taobao.org/mirrors/node-sass/`
	`2`	`+package-lock=false`