Migrate to Typescript (#123)

scriptex · web-flow · commit 9d8b2a16c1c0 · 2022-12-07T14:01:34.000+02:00
* Migrate to Typescript

* Update build workflow
diff --git a/.babelrc b/.babelrc
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,15 @@
+{
+	"env": {
+		"node": true,
+		"browser": true
+	},
+	"extends": ["prettier", "plugin:@typescript-eslint/recommended"],
+	"parser": "@typescript-eslint/parser",
+	"parserOptions": {
+		"project": "tsconfig.json",
+		"sourceType": "module"
+	},
+	"plugins": ["@typescript-eslint"],
+	"ignorePatterns": ["*.js", "*.mjs"],
+	"rules": {}
+}
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,21 +1,14 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
 name: Build
 
-on:
-    push:
-        branches: [master]
-    pull_request:
-        branches: [master]
+on: [push, pull_request]
 
 jobs:
     build:
         runs-on: ubuntu-latest
 
         strategy:
             matrix:
-                node-version: [12.x, 14.x, 16.x]
+                node-version: [18.x]
 
         steps:
             - uses: actions/checkout@v3
@@ -24,4 +17,5 @@ jobs:
               with:
                   node-version: ${{ matrix.node-version }}
             - run: yarn
+            - run: yarn lint
             - run: yarn build
diff --git a/.gitignore b/.gitignore
@@ -16,3 +16,5 @@ node_modules/
 .Trashes
 ehthumbs.db
 Thumbs.db
+
+dist
diff --git a/.npmignore b/.npmignore
@@ -6,7 +6,7 @@ yarn-debug.log*
 yarn-error.log*
 
 # Dependency directory
-node_modules/
+node_modules
 
 # Misc
 .DS_Store
@@ -17,26 +17,27 @@ node_modules/
 ehthumbs.db
 Thumbs.db
 
-# EditorConfig
+# Config folders and files
+.github
+_config.yml
+_.config.yml
+.codebeatsettings
 .editorconfig
-
-# Git
-.gitignore
+.eslintrc
 .gitattributes
-
-# CI
-.travis.yml
-
-# lock files
-yarn.lock
-
-# Prettier
-.prettierrc
+.gitignore
+.nvmrc
 .prettierignore
-
-# Config files
-.babelrc
-.github
+.prettierrc
+.stylelintignore
+.stylelintrc
+.travis.yml
 .whitesource
 renovate.json
-webpack.config.js
+tsconfig.json
+tslint.json
+yarn.lock
+
+!dist
+demo
+rollup.config.mjs
diff --git a/.travis.yml b/.travis.yml
@@ -5,4 +5,5 @@ node_js:
 install:
     - yarn
 script:
+    - yarn lint
     - yarn build
diff --git a/.whitesource b/.whitesource
@@ -1,8 +1,8 @@
 {
-  "checkRunSettings": {
-    "vulnerableCheckRunConclusionLevel": "success"
-  },
-  "issueSettings": {
-    "minSeverityLevel": "LOW"
-  }
-}
+	"generalSettings": {
+		"shouldScanRepo": true
+	},
+	"checkRunSettings": {
+		"vulnerableCheckRunConclusionLevel": "success"
+	}
+}
diff --git a/README.md b/README.md
@@ -1,15 +1,14 @@
 [![GitHub release](https://img.shields.io/github/release/three11/extract-query-arg.svg)](https://github.com/three11/extract-query-arg/releases/latest)
 [![GitHub issues](https://img.shields.io/github/issues/three11/extract-query-arg.svg)](https://github.com/three11/extract-query-arg/issues)
 [![GitHub last commit](https://img.shields.io/github/last-commit/three11/extract-query-arg.svg)](https://github.com/three11/extract-query-arg/commits/master)
-[![Github file size](https://img.shields.io/github/size/three11/extract-query-arg/dist/extract-query-arg.min.js.svg)](https://github.com/three11/extract-query-arg/)
 [![Build Status](https://travis-ci.org/three11/extract-query-arg.svg?branch=master)](https://travis-ci.org/three11/extract-query-arg)
 [![npm](https://img.shields.io/npm/dt/@three11/extract-query-arg.svg)](https://www.npmjs.com/package/@three11/extract-query-arg)
 [![npm](https://img.shields.io/npm/v/@three11/extract-query-arg.svg)](https://www.npmjs.com/package/@three11/extract-query-arg)
 [![Analytics](https://ga-beacon.appspot.com/UA-83446952-1/github.com/three11/extract-query-arg/README.md)](https://github.com/three11/extract-query-arg/)
 
 # Extract Query Argument
 
-A vanilla ES2017 module for extracting query arguments from url.
+> Extract a query string from a given URL
 
 ## Install
 
diff --git a/_.config.yml b/_.config.yml
@@ -0,0 +1,14 @@
+plugins:
+    - jekyll-relative-links
+relative_links:
+    enabled: true
+    collections: true
+include:
+    - CONTRIBUTING.md
+    - README.md
+    - LICENSE.md
+    - COPYING.md
+    - CODE_OF_CONDUCT.md
+    - CONTRIBUTING.md
+    - ISSUE_TEMPLATE.md
+    - PULL_REQUEST_TEMPLATE.md
diff --git a/dist/extract-query-arg.js b/dist/extract-query-arg.js
diff --git a/dist/extract-query-arg.min.js b/dist/extract-query-arg.min.js
diff --git a/package.json b/package.json
@@ -1,23 +1,23 @@
 {
 	"name": "@three11/extract-query-arg",
-	"version": "1.0.0",
+	"version": "2.0.0",
 	"description": "Extract query argument from url",
-	"main": "dist/extract-query-arg.min.js",
-	"scripts": {
-		"dist": "babel src/extract-query-arg.js --out-file dist/extract-query-arg.js",
-		"minify": "babel src/extract-query-arg.js --out-file dist/extract-query-arg.min.js --presets minify,@babel/env",
-		"build": "npm run dist && npm run minify"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/three11/extract-query-arg.git"
-	},
 	"keywords": [
-		"extract",
+		"qs",
+		"url",
+		"parse",
 		"query",
-		"argument",
-		"GET"
+		"encode",
+		"decode",
+		"string",
+		"querystring",
+		"searchparams"
 	],
+	"homepage": "https://github.com/three11/extract-query-arg#readme",
+	"bugs": {
+		"url": "https://github.com/three11/extract-query-arg/issues"
+	},
+	"license": "GPL-3.0",
 	"authors": [
 		{
 			"name": "Three 11 Ltd",
@@ -35,16 +35,31 @@
 			"role": "Developer"
 		}
 	],
-	"license": "GPL-3.0",
-	"bugs": {
-		"url": "https://github.com/three11/extract-query-arg/issues"
+	"repository": {
+		"type": "git",
+		"url": "github:three11/extract-query-arg"
 	},
-	"homepage": "https://github.com/three11/extract-query-arg#readme",
+	"scripts": {
+		"lint": "eslint 'src/**/*.ts'",
+		"build": "microbundle"
+	},
+	"dependencies": {},
 	"devDependencies": {
-		"@babel/cli": "7.19.3",
-		"@babel/core": "7.20.5",
-		"@babel/plugin-transform-modules-umd": "7.18.6",
-		"@babel/preset-env": "7.20.2",
-		"babel-minify": "0.5.2"
-	}
+		"@typescript-eslint/eslint-plugin": "5.45.0",
+		"@typescript-eslint/parser": "5.45.0",
+		"eslint": "8.28.0",
+		"eslint-config-prettier": "8.5.0",
+		"microbundle": "0.15.1",
+		"typescript": "4.9.3"
+	},
+	"type": "module",
+	"source": "src/extract-query-arg.ts",
+	"exports": {
+		"require": "./dist/extract-query-arg.cjs",
+		"default": "./dist/extract-query-arg.modern.js"
+	},
+	"main": "./dist/extract-query-arg.cjs",
+	"types": "./dist/extract-query-arg.d.ts",
+	"module": "./dist/extract-query-arg.module.js",
+	"unpkg": "./dist/extract-query-arg.umd.js"
 }
diff --git a/src/extract-query-arg.ts b/src/extract-query-arg.ts
@@ -1,4 +1,4 @@
-const extractQueryArg = (queryArg, url = window.location.href) => {
+export const extractQueryArg = (queryArg: string, url = window.location.href): string | null => {
 	queryArg = queryArg.replace(/[\[\]]/g, '\\$&');
 
 	const matches = new RegExp(`[?&]${queryArg}(=([^&#]*)|&|#|$)`).exec(url);
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,39 @@
+{
+	"compilerOptions": {
+		"allowJs": false,
+		"allowSyntheticDefaultImports": true,
+		"alwaysStrict": true,
+		"baseUrl": "./",
+		"checkJs": false,
+		"declaration": true,
+		"emitDecoratorMetadata": true,
+		"experimentalDecorators": true,
+		"forceConsistentCasingInFileNames": true,
+		"importHelpers": false,
+		"isolatedModules": true,
+		"jsx": "react",
+		"lib": ["DOM", "ESNext"],
+		"module": "ESNext",
+		"moduleResolution": "Node",
+		"noEmit": false,
+		"noEmitHelpers": false,
+		"noEmitOnError": true,
+		"noFallthroughCasesInSwitch": true,
+		"noImplicitAny": true,
+		"noImplicitReturns": true,
+		"noImplicitThis": true,
+		"noStrictGenericChecks": false,
+		"outDir": "./dist",
+		"pretty": true,
+		"removeComments": false,
+		"sourceMap": true,
+		"strict": true,
+		"strictBindCallApply": true,
+		"strictFunctionTypes": true,
+		"strictPropertyInitialization": true,
+		"strictNullChecks": true,
+		"target": "ESNext"
+	},
+	"include": ["src/*.ts"],
+	"exclude": ["node_modules"]
+}
diff --git a/yarn.lock b/yarn.lock
