switch to typescript (#15)

* switch to typescript

* refactor

* add cjs, mjs & ts examples

* add codeql ts support

is codeql even necessary for this?

* drop node 15 and add node 20

* update readme

* remove path aliases

* update changelog

---------

Co-authored-by: Kyriakos Nicola <knicola@users.noreply.github.com>

.eslintrc.js

@@ -0,0 +1,11 @@
+require('@knicola/dev-config/eslint/patch')
+
+module.exports = {
+    extends: ['./node_modules/@knicola/dev-config/eslint/node'],
+    parserOptions: { tsconfigRootDir: __dirname },
+    settings: {
+        'import/resolver': {
+            typescript: { project: __dirname },
+        },
+    },
+}

.github/workflows/codeql-analysis.yml

@@ -32,7 +32,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
+        language: [ 'javascript-typescript' ]
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
         # Learn more:
         # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed

.github/workflows/node.js.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [15.x, 16.x, 18.x]
+        node-version: [16.x, 18.x, 20.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "editor.formatOnSave": false,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+},
+  "eslint.format.enable": true
+}

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [next-version] - next-release-date
+### Changed
+* Switched to Typescript.
+
+### Removed
+* Deprecated method `.minRepeating()`.
+
 ## [0.3.0] - 2024-03-02
 ### Changed
 * Bump `@types/jest` from 27.0.1 to 29.5.12

README.md

@@ -19,13 +19,13 @@ $ yarn add yup-password
 ## Usage
 Plug and play:
 ```js
-// ES6
+// MJS / TS
 import * as yup from 'yup'
 import YupPassword from 'yup-password'
 YupPassword(yup) // extend yup
 ```
 ```js
-// CommonJs
+// CJS
 const yup = require('yup')
 require('yup-password')(yup) // extend yup
 ```
@@ -62,7 +62,7 @@ const schema = yup.string().password()
     .minWords(2) // add an additional rule
 
 try {
-    const res = await schema.validate('secret')
+    const res = await schema.validate('secret', { abortEarly: false })
     //  ...
 } catch(e) {
     console.log(e.errors) // => [
@@ -76,7 +76,7 @@ try {
 ```
 Pick and choose your password rules:
 ```js
-const schema = yup.string().min(6).minUppercase(3).minRepeating(2).minWords(2)
+const schema = yup.string().min(6).minUppercase(3).maxRepeating(2).minWords(2)
 
 await schema.isValid('Now, THIS is some password.') // => true
 await schema.isValid('But thiiis is not.') // => false

examples/javascript.cjs

@@ -0,0 +1,16 @@
+/* eslint-disable no-console */
+'use strict'
+
+const yup = require('yup')
+require('../dist/index.js')(yup)
+
+const schema = yup.object({
+    password: yup.string().password(),
+})
+
+const input = {
+    password: 'weak',
+}
+
+schema.validate(input, { abortEarly: false })
+    .catch(e => console.error(e.errors))

examples/javascript.mjs

@@ -0,0 +1,17 @@
+/* eslint-disable no-console */
+'use strict'
+
+import * as yup from 'yup'
+import YupPassword from '../dist/index.js'
+YupPassword(yup)
+
+const schema = yup.object({
+    password: yup.string().password(),
+})
+
+const input = {
+    password: 'weak',
+}
+
+schema.validate(input, { abortEarly: false })
+    .catch(e => console.error(e.errors))

examples/typescript.ts

@@ -0,0 +1,15 @@
+/* eslint-disable no-console */
+import * as yup from 'yup'
+import YupPassword from '../src'
+YupPassword(yup)
+
+const schema = yup.object({
+    password: yup.string().password(),
+})
+
+const input = {
+    password: 'weak',
+}
+
+schema.validate(input, { abortEarly: false })
+    .catch(e => console.error(e.errors))

jest.config.ts

@@ -0,0 +1,24 @@
+import { JestConfigWithTsJest } from 'ts-jest'
+
+const config: JestConfigWithTsJest = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    bail: true,
+    testMatch: [
+        '<rootDir>/tests/**/*.spec.ts',
+        '<rootDir>/tests/**/*.test.ts',
+    ],
+    collectCoverageFrom: [
+        '<rootDir>/src/**/*.ts',
+    ],
+    coverageThreshold: {
+        global: {
+            branches: 100,
+            functions: 100,
+            lines: 100,
+            statements: 0,
+        },
+    },
+}
+
+export default config