From 65f3526cb37c02e0a7fcf14eb683a9f80999ae09 Mon Sep 17 00:00:00 2001 From: ankurk91 Date: Fri, 14 Oct 2022 15:29:51 +0530 Subject: [PATCH] next: rewrite in typescript :rocket: --- .babelrc | 33 - .github/ISSUE_TEMPLATE.md | 2 +- .github/workflows/build.yml | 4 +- README.md | 70 +- __test__/{emits.spec.js => emits.spec.ts} | 0 __test__/{events.spec.js => events.spec.ts} | 2 +- .../{instance.spec.js => instance.spec.ts} | 2 +- __test__/{plugin.spec.js => plugin.spec.ts} | 0 __test__/{props.spec.js => props.spec.ts} | 16 +- .../{watchers.spec.js => watchers.spec.ts} | 4 +- examples/App.vue | 2 +- jest.config.js | 10 +- package.json | 25 +- pnpm-lock.yaml | 1239 ++--------------- src/{component.js => component.ts} | 82 +- src/{events.js => events.ts} | 7 +- src/{index.js => index.ts} | 0 src/util.js | 13 - src/util.ts | 23 + tsconfig.json | 26 + types/component.d.ts | 126 -- types/index.d.ts | 5 - webpack.config.dev.js | 12 +- webpack.config.js | 18 +- 24 files changed, 295 insertions(+), 1426 deletions(-) delete mode 100644 .babelrc rename __test__/{emits.spec.js => emits.spec.ts} (100%) rename __test__/{events.spec.js => events.spec.ts} (99%) rename __test__/{instance.spec.js => instance.spec.ts} (96%) rename __test__/{plugin.spec.js => plugin.spec.ts} (100%) rename __test__/{props.spec.js => props.spec.ts} (59%) rename __test__/{watchers.spec.js => watchers.spec.ts} (96%) rename src/{component.js => component.ts} (70%) rename src/{events.js => events.ts} (77%) rename src/{index.js => index.ts} (100%) delete mode 100644 src/util.js create mode 100644 src/util.ts create mode 100644 tsconfig.json delete mode 100644 types/component.d.ts delete mode 100644 types/index.d.ts diff --git a/.babelrc b/.babelrc deleted file mode 100644 index 1044612..0000000 --- a/.babelrc +++ /dev/null @@ -1,33 +0,0 @@ -{ - "presets": [ - [ - "@babel/preset-env", - { - "modules": false, - "forceAllTransforms": false, - "targets": { - "browsers": [ - "defaults", - "not dead", - "not ie 11" - ] - } - } - ] - ], - "plugins": [], - "env": { - "test": { - "presets": [ - [ - "@babel/preset-env", - { - "targets": { - "node": "current" - } - } - ] - ] - } - } -} diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index f254c4b..4fac6de 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -11,7 +11,7 @@ * flatPickr version : 4.6.x * Vue.js version : 3.2 * Browser name and version : Chrome|Firefox|Edge x.x.x -* This package version : 10.x.x +* This package version : 11.x.x **Current behavior** diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 722cf8f..89564e9 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -3,11 +3,11 @@ name: build on: push: branches: - - master + - main - dev pull_request: branches: - - master + - main - dev schedule: - cron: '0 0 11 * *' diff --git a/README.md b/README.md index 12b092c..9058205 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ [![npm-version](https://badgen.net/npm/v/vue-flatpickr-component)](https://www.npmjs.com/package/vue-flatpickr-component) [![github-tag](https://badgen.net/github/tag/ankurk91/vue-flatpickr-component)](https://github.com/ankurk91/vue-flatpickr-component/tags) [![build](https://github.com/ankurk91/vue-flatpickr-component/workflows/build/badge.svg)](https://github.com/ankurk91/vue-flatpickr-component/actions) -[![codecov](https://codecov.io/gh/ankurk91/vue-flatpickr-component/branch/master/graph/badge.svg)](https://codecov.io/gh/ankurk91/vue-flatpickr-component) -[![license](https://badgen.net/github/license/ankurk91/vue-flatpickr-component)](https://yarnpkg.com/en/package/vue-flatpickr-component) -![TypeScript](https://badgen.net/badge/icon/Typed?icon=typescript&label&labelColor=blue&color=555555) +[![codecov](https://codecov.io/gh/ankurk91/vue-flatpickr-component/branch/main/graph/badge.svg)](https://codecov.io/gh/ankurk91/vue-flatpickr-component) +[![license](https://badgen.net/github/license/ankurk91/vue-flatpickr-component)](LICENSE.txt) +![ts](https://badgen.net/badge/Built%20With/TypeScript/blue) Vue.js component for [Flatpickr](https://flatpickr.js.org/) date-time picker. @@ -15,10 +15,10 @@ Vue.js component for [Flatpickr](https://flatpickr.js.org/) date-time picker. ### Version matrix -|Vue.js version|Package version | Branch | -|:-------------|:--------------:|--------------------------------------------------------------------:| -| 2.x | 8.x | [8.x](https://github.com/ankurk91/vue-flatpickr-component/tree/8.x) | -| 3.x | 10.x | `master` | +|Vue.js version| Package version | Branch | +|:-------------|:---------------:|--------------------------------------------------------------------:| +| 2.x | 8.x | [8.x](https://github.com/ankurk91/vue-flatpickr-component/tree/8.x) | +| 3.x | 11.x | `main` | ## Features @@ -35,7 +35,7 @@ Vue.js component for [Flatpickr](https://flatpickr.js.org/) date-time picker. ## Installation ```bash -npm install vue-flatpickr-component@^10 +npm install vue-flatpickr-component@^11 ``` ## Usage @@ -48,21 +48,12 @@ npm install vue-flatpickr-component@^10 - ``` @@ -99,7 +90,8 @@ Using Bootstrap [input group](https://getbootstrap.com/docs/4.6/components/input - ``` @@ -153,9 +135,9 @@ The component accepts these props: |:----------|:-----------------------------------------------:|:----------------------------------------------:|:-----------------------------------------------------------------------| | v-model | String / Date Object / Array / Timestamp / null | `null` | Set or Get date-picker value (required) | | config | Object | `{ wrap: false }` | Flatpickr configuration [options](https://flatpickr.js.org/options/) | -| events | Array | Array of sensible [events](./src/events.js#L2) | Customise the [events](https://flatpickr.js.org/events/) to be emitted | +| events | Array | Array of sensible [events](./src/events.ts#L2) | Customise the [events](https://flatpickr.js.org/events/) to be emitted | -## Install in non-module environments (without webpack) +## Use in browser with CDN ```html @@ -164,7 +146,7 @@ The component accepts these props: - +