Merge pull request #4 from anish2690/feat/types

anish2690 · web-flow · commit 4895f5710ea4 · 2020-11-07T11:50:20.000+05:30
fix: type definition support
diff --git a/.github/commit-convention.md b/.github/commit-convention.md
@@ -0,0 +1,91 @@
+## Git Commit Message Convention
+
+> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
+
+#### TL;DR:
+
+Messages must be matched by the following regex:
+
+```text
+/^(revert: )?(feat|fix|docs|dx|style|refactor|perf|test|workflow|build|ci|chore|types|wip)(\(.+\))?: .{1,50}/
+```
+
+#### Examples
+
+Appears under "Features" header, `link` subheader:
+
+```
+feat(link): add `force` option
+```
+
+Appears under "Bug Fixes" header, `view` subheader, with a link to issue #28:
+
+```
+fix(view): handle keep-alive with aborted navigations
+
+close #28
+```
+
+Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
+
+```
+perf: improve guard extraction
+
+BREAKING CHANGE: The 'beforeRouteEnter' option has been removed.
+```
+
+The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.
+
+```
+revert: feat(compiler): add 'comments' option
+
+This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
+```
+
+### Full Message Format
+
+A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
+
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+The **header** is mandatory and the **scope** of the header is optional.
+
+### Revert
+
+If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body, it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
+
+### Type
+
+If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog. However, if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.
+
+Other prefixes are up to your discretion. Suggested prefixes are `docs`, `chore`, `style`, `refactor`, and `test` for non-changelog related tasks.
+
+### Scope
+
+The scope could be anything specifying the place of the commit change. For example `core`, `compiler`, `ssr`, `v-model`, `transition` etc...
+
+### Subject
+
+The subject contains a succinct description of the change:
+
+- use the imperative, present tense: "change" not "changed" nor "changes"
+- don't capitalize the first letter
+- no dot (.) at the end
+
+### Body
+
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
+The body should include the motivation for the change and contrast this with previous behavior.
+
+### Footer
+
+The footer should contain any information about **Breaking Changes** and is also the place to
+reference GitHub issues that this commit **Closes**.
+
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,11 @@
 node_modules
+demo_dist
+coverage
+npm-debug.log
+yarn-error.log
+.nyc_output
+coverage.lcov
 dist
-demo_dist
+package-lock.json
+.DS_Store
+temp
diff --git a/api-extractor.json b/api-extractor.json
@@ -0,0 +1,49 @@
+// this the shared base config for all packages.
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+
+  "mainEntryPointFilePath": "./dist/src/index.d.ts",
+
+  "apiReport": {
+    "enabled": true,
+    "reportFolder": "<projectFolder>/temp/"
+  },
+
+  "docModel": {
+    "enabled": true
+  },
+
+  "dtsRollup": {
+    "enabled": true,
+    "untrimmedFilePath": "./dist/<unscopedPackageName>.d.ts"
+  },
+
+  "tsdocMetadata": {
+    "enabled": false
+  },
+
+  "messages": {
+    "compilerMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    },
+
+    "extractorMessageReporting": {
+      "default": {
+        "logLevel": "warning",
+        "addToApiReportFile": true
+      },
+
+      "ae-missing-release-tag": {
+        "logLevel": "none"
+      }
+    },
+
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    }
+  }
+}
diff --git a/package.json b/package.json
@@ -1,35 +1,38 @@
 {
   "name": "vue-draggable-next",
-  "version": "1.0.8",
-  "description": "",
+  "version": "2.0.0",
+  "description": "Build Draggable component using vue 3",
   "main": "dist/vue-draggable-next.cjs.js",
-  "browser": "dist/vue-draggable-next.esm.js",
   "unpkg": "dist/vue-draggable-next.global.js",
   "jsdelivr": "dist/vue-draggable-next.global.js",
   "module": "dist/vue-draggable-next.esm-bundler.js",
+  "types": "dist/vue-draggable-next.d.ts",
+  "sideEffects": false,
+  "author": {
+    "name": "Anish George",
+    "email": "anishgeorge2690@gmail.com"
+  },
   "scripts": {
     "build": "rollup -c rollup.config.js",
-    "dev": "vite serve",
-    "start": "vite serve --mode production",
-    "demo:build": "cross-env NODE_ENV=production vite build",
-    "release": "bash scripts/release.sh",
     "build:dts": "api-extractor run --local --verbose",
+    "release": "bash scripts/release.sh",
+    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 1",
+    "size": "size-limit",
     "lint": "prettier -c --parser typescript \"{src,__tests__,e2e}/**/*.[jt]s?(x)\"",
     "lint:fix": "yarn run lint --write",
-    "test:types": "tsc --build tsconfig.json"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/anish2690/vue-draggable-next.git"
-  },
-  "author": {
-    "name": "Anish George",
-    "email": "anishgeorge2690@gmail.com"
-  },
-  "license": "MIT",
-  "engines": {
-    "node": ">=10.16.0"
+    "test:types": "tsc --build tsconfig.json",
+    "test:unit": "jest --coverage",
+    "test": "yarn run test:types && yarn run test:unit && yarn run build && yarn run build:dts",
+    "playground:dev": "vite serve",
+    "playground:start": "vite serve --mode production",
+    "playground:build": "cross-env NODE_ENV=production vite build"
   },
+  "files": [
+    "dist/*.js",
+    "dist/vue-draggable-next.d.ts",
+    "LICENSE",
+    "README.md"
+  ],
   "keywords": [
     "typescript",
     "javascript",
@@ -40,30 +43,66 @@
     "vue-draggable",
     "vue-draggable-next"
   ],
-  "dependencies": {
-    "sortablejs": "^1.10.2"
-  },
+  "license": "MIT",
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^14.0.0",
-    "@rollup/plugin-node-resolve": "^8.4.0",
-    "@rollup/plugin-replace": "^2.3.3",
-    "@tailwindcss/ui": "^0.5.0",
-    "@types/sortablejs": "^1.10.5",
-    "@vue/compiler-sfc": "^3.0.0",
+    "@microsoft/api-extractor": "7.8.1",
+    "@rollup/plugin-alias": "^3.1.1",
+    "@rollup/plugin-commonjs": "^16.0.0",
+    "@rollup/plugin-node-resolve": "^10.0.0",
+    "@rollup/plugin-replace": "^2.3.4",
+    "@size-limit/preset-small-lib": "^4.7.0",
+    "@tailwindcss/ui": "^0.7.2",
+    "@types/jest": "^26.0.15",
+    "@types/jsdom": "^16.2.5",
+    "@types/sortablejs": "^1.10.6",
+    "@vue/test-utils": "^2.0.0-beta.8",
+    "codecov": "^3.8.1",
+    "conventional-changelog-cli": "^2.1.1",
     "cross-env": "^7.0.2",
+    "jest": "^26.5.3",
+    "lint-staged": "^10.5.1",
     "pascalcase": "^1.0.0",
-    "prettier": "^2.0.5",
-    "rollup-plugin-terser": "^6.1.0",
-    "rollup-plugin-typescript2": "^0.27.1",
-    "tailwindcss": "^1.7.5",
-    "ts-node": "^8.10.2",
-    "typescript": "^3.9.7",
-    "vite": "^1.0.0-rc.4",
-    "vue": "^3.0.0",
-    "vuex": "^4.0.0-beta.4"
+    "prettier": "^2.1.2",
+    "rollup": "^2.33.1",
+    "rollup-plugin-terser": "^7.0.2",
+    "rollup-plugin-typescript2": "^0.29.0",
+    "size-limit": "^4.7.0",
+    "sortablejs": "^1.12.0",
+    "tailwindcss": "^1.9.6",
+    "ts-jest": "^26.4.1",
+    "typescript": "^4.0.5",
+    "vite": "^1.0.0-rc.9",
+    "vue": "^3.0.2",
+    "vuex": "^4.0.0-rc.1",
+    "yorkie": "^2.0.0"
+  },
+  "gitHooks": {
+    "pre-commit": "lint-staged",
+    "commit-msg": "node scripts/verifyCommit.js"
+  },
+  "lint-staged": {
+    "*.js": [
+      "prettier --write"
+    ],
+    "*.ts?(x)": [
+      "prettier --parser=typescript --write"
+    ]
   },
+  "size-limit": [
+    {
+      "path": "size-checks/basic.js"
+    }
+  ],
   "peerDependencies": {
-    "sortablejs": "^1.10.2",
+    "sortablejs": "^1.12.0",
     "vue": "^3.0.0"
-  }
-}
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anish2690/vue-draggable-next.git"
+  },
+  "bugs": {
+    "url": "https://github.com/anish2690/vue-draggable-next/issues"
+  },
+  "homepage": "https://github.com/anish2690/vue-draggable-next#readme"
+}
diff --git a/rollup.config.js b/rollup.config.js
@@ -46,7 +46,7 @@ const outputConfigs = {
     format: `iife`,
   },
   esm: {
-    file: pkg.browser,
+    file: pkg.browser || pkg.module.replace('-bundler.js', '-browser.js'),
     format: `es`,
   },
 }
diff --git a/scripts/verifyCommit.js b/scripts/verifyCommit.js
@@ -0,0 +1,27 @@
+// Invoked on the commit-msg git hook by yorkie.
+
+const chalk = require('chalk')
+const msgPath = process.env.GIT_PARAMS
+const msg = require('fs').readFileSync(msgPath, 'utf-8').trim()
+
+const commitRE = /^(revert: )?(feat|fix|docs|dx|style|refactor|perf|test|workflow|build|ci|chore|types|wip|release)(\(.+\))?: .{1,50}/
+
+if (!commitRE.test(msg)) {
+  console.log()
+  console.error(
+    `  ${chalk.bgRed.white(' ERROR ')} ${chalk.red(
+      `invalid commit message format.`
+    )}\n\n` +
+      chalk.red(
+        `  Proper commit message format is required for automated changelog generation. Examples:\n\n`
+      ) +
+      `    ${chalk.green(
+        `fix(view): handle keep-alive with aborted navigations`
+      )}\n` +
+      `    ${chalk.green(
+        `fix(view): handle keep-alive with aborted navigations (close #28)`
+      )}\n\n` +
+      chalk.red(`  See .github/commit-convention.md for more details.\n`)
+  )
+  process.exit(1)
+}
diff --git a/src/VueDraggableNext.ts b/src/VueDraggableNext.ts
@@ -1,6 +1,6 @@
 import Sortable from 'sortablejs'
 import { insertNodeAt, camelize, console, removeNode } from './util/helper'
-import { h, defineComponent, VNode, resolveComponent } from 'vue'
+import { h, VNode, resolveComponent, defineComponent } from 'vue'
 // TODO
 interface OpenObject {
   [key: string]: any
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,30 +1,34 @@
 {
-  "include": ["src/global.d.ts", "src/**/*.ts", "__tests__/**/*.ts"],
+  "include": [
+    "src/global.d.ts",
+    "src/**/*.ts",
+    "__tests__/**/*.ts"
+  ],
   "compilerOptions": {
     "baseUrl": ".",
     "rootDir": ".",
     "outDir": "dist",
     "sourceMap": false,
     "noEmit": true,
-
     "target": "esnext",
     "module": "esnext",
     "moduleResolution": "node",
     "allowJs": true,
-
     "noUnusedLocals": true,
     "strictNullChecks": true,
     "noImplicitAny": true,
     "noImplicitThis": true,
     "noImplicitReturns": true,
     "strict": true,
     "isolatedModules": false,
-
     "experimentalDecorators": true,
     "resolveJsonModule": true,
     "esModuleInterop": true,
     "removeComments": false,
     "jsx": "preserve",
-    "lib": ["esnext", "dom"]
+    "lib": [
+      "esnext",
+      "dom"
+    ]
   }
-}
+}
diff --git a/yarn-error.log b/yarn-error.log
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ const outputConfigs = {`
`46`	`46`	format: `iife`,
`47`	`47`	`},`
`48`	`48`	`esm: {`
`49`		`- file: pkg.browser,`
	`49`	`+ file: pkg.browser \|\| pkg.module.replace('-bundler.js', '-browser.js'),`
`50`	`50`	format: `es`,
`51`	`51`	`},`
`52`	`52`	`}`