From eb657187ff873c91cc1a5f538ec713cc374180b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eduardo=20Esteban=20Alvarez=20Casta=C3=B1eda?= Date: Tue, 24 Jan 2023 14:29:17 -0300 Subject: [PATCH 1/8] chore: add linter to markdown documents --- .lintstagedrc | 4 + package-lock.json | 393 ++++++++++++++++++++++++++++++++++++++++++++-- package.json | 4 +- 3 files changed, 391 insertions(+), 10 deletions(-) diff --git a/.lintstagedrc b/.lintstagedrc index 15dd9ad..0b60f8a 100644 --- a/.lintstagedrc +++ b/.lintstagedrc @@ -2,5 +2,9 @@ "*.{ts,tsx,js,jsx}": [ "npm run lint:fix", "git add" + ], + ".md": [ + "markdownlint --fix", + "git add" ] } \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index baa37b6..6045c7a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,13 +1,12 @@ { "name": "vertical-timeline-component-react", - "version": "4.4.0", + "version": "4.4.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "vertical-timeline-component-react", - "version": "4.4.0", - "hasInstallScript": true, + "version": "4.4.1", "license": "MIT", "dependencies": { "react": "^17.0.2", @@ -41,6 +40,8 @@ "jest": "^28.1.3", "jest-environment-jsdom": "^29.0.1", "lint-staged": "^13.1.0", + "markdownlint": "^0.27.0", + "markdownlint-cli": "^0.33.0", "prettier": "^2.5.0", "ts-jest": "^28.0.8", "ts-node": "^10.9.1", @@ -4047,6 +4048,15 @@ "integrity": "sha512-Q6fKUPqnAHAyhiUgFU7BUzLiv0kd8saH9al7tnu5Q/okj6dnupxyTgFIBjVzJATdfIAm9NAsvXNzjaKa+bxVyA==", "dev": true }, + "node_modules/deep-extend": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", + "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", + "dev": true, + "engines": { + "node": ">=4.0.0" + } + }, "node_modules/deep-is": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", @@ -5271,6 +5281,18 @@ "node": ">=10" } }, + "node_modules/get-stdin": { + "version": "9.0.0", + "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-9.0.0.tgz", + "integrity": "sha512-dVKBjfWisLAicarI2Sf+JuBE/DghV4UzNAVe9yhEJuzeREd3JhOTE9cUaJTeSa77fsbQUK3pcOpJfM59+VKZaA==", + "dev": true, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/get-stream": { "version": "6.0.1", "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz", @@ -5709,9 +5731,9 @@ } }, "node_modules/ignore": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.0.tgz", - "integrity": "sha512-CmxgYGiEPCLhfLnpPp1MoRmifwEIOgjcHXxOBjv7mY96c+eWScsOP9c112ZyLdWHi0FxHjI+4uVhKYp/gcdRmQ==", + "version": "5.2.4", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.4.tgz", + "integrity": "sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ==", "dev": true, "engines": { "node": ">= 4" @@ -7751,6 +7773,12 @@ "node": ">=6" } }, + "node_modules/jsonc-parser": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.2.0.tgz", + "integrity": "sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==", + "dev": true + }, "node_modules/jsonfile": { "version": "6.1.0", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", @@ -7876,6 +7904,15 @@ "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", "dev": true }, + "node_modules/linkify-it": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-4.0.1.tgz", + "integrity": "sha512-C7bfi1UZmoj8+PQx22XyeXCuBlokoyWQL5pWSP+EI6nzRylyThouddufc2c1NDIcP9k5agmN9fLpA7VNJfIiqw==", + "dev": true, + "dependencies": { + "uc.micro": "^1.0.1" + } + }, "node_modules/lint-staged": { "version": "13.1.0", "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-13.1.0.tgz", @@ -8352,6 +8389,148 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/markdown-it": { + "version": "13.0.1", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-13.0.1.tgz", + "integrity": "sha512-lTlxriVoy2criHP0JKRhO2VDG9c2ypWCsT237eDiLqi09rmbKoUetyGHq2uOIRoRS//kfoJckS0eUzzkDR+k2Q==", + "dev": true, + "dependencies": { + "argparse": "^2.0.1", + "entities": "~3.0.1", + "linkify-it": "^4.0.1", + "mdurl": "^1.0.1", + "uc.micro": "^1.0.5" + }, + "bin": { + "markdown-it": "bin/markdown-it.js" + } + }, + "node_modules/markdown-it/node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true + }, + "node_modules/markdown-it/node_modules/entities": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-3.0.1.tgz", + "integrity": "sha512-WiyBqoomrwMdFG1e0kqvASYfnlb0lp8M5o5Fw2OFq1hNZxxcNk8Ik0Xm7LxzBhuidnZB/UtBqVCgUz3kBOP51Q==", + "dev": true, + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/markdownlint": { + "version": "0.27.0", + "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.27.0.tgz", + "integrity": "sha512-HtfVr/hzJJmE0C198F99JLaeada+646B5SaG2pVoEakLFI6iRGsvMqrnnrflq8hm1zQgwskEgqSnhDW11JBp0w==", + "dev": true, + "dependencies": { + "markdown-it": "13.0.1" + }, + "engines": { + "node": ">=14.18.0" + } + }, + "node_modules/markdownlint-cli": { + "version": "0.33.0", + "resolved": "https://registry.npmjs.org/markdownlint-cli/-/markdownlint-cli-0.33.0.tgz", + "integrity": "sha512-zMK1oHpjYkhjO+94+ngARiBBrRDEUMzooDHBAHtmEIJ9oYddd9l3chCReY2mPlecwH7gflQp1ApilTo+o0zopQ==", + "dev": true, + "dependencies": { + "commander": "~9.4.1", + "get-stdin": "~9.0.0", + "glob": "~8.0.3", + "ignore": "~5.2.4", + "js-yaml": "^4.1.0", + "jsonc-parser": "~3.2.0", + "markdownlint": "~0.27.0", + "minimatch": "~5.1.2", + "run-con": "~1.2.11" + }, + "bin": { + "markdownlint": "markdownlint.js" + }, + "engines": { + "node": ">=14" + } + }, + "node_modules/markdownlint-cli/node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true + }, + "node_modules/markdownlint-cli/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/markdownlint-cli/node_modules/commander": { + "version": "9.4.1", + "resolved": "https://registry.npmjs.org/commander/-/commander-9.4.1.tgz", + "integrity": "sha512-5EEkTNyHNGFPD2H+c/dXXfQZYa/scCKasxWcXJaWnNJ99pnQN9Vnmqow+p+PlFPE63Q6mThaZws1T+HxfpgtPw==", + "dev": true, + "engines": { + "node": "^12.20.0 || >=14" + } + }, + "node_modules/markdownlint-cli/node_modules/glob": { + "version": "8.0.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-8.0.3.tgz", + "integrity": "sha512-ull455NHSHI/Y1FqGaaYFaLGkNMMJbavMrEGFXG/PGrg6y7sutWHUHrz6gy6WEBH6akM1M414dWKCNs+IhKdiQ==", + "dev": true, + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^5.0.1", + "once": "^1.3.0" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/markdownlint-cli/node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "dev": true, + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/markdownlint-cli/node_modules/minimatch": { + "version": "5.1.6", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz", + "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==", + "dev": true, + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/mdurl": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", + "integrity": "sha512-/sKlQJCBYVY9Ers9hqzKou4H6V5UWc/M59TH2dvkt+84itfnq7uFOMLpOiOS4ujvHP4etln18fmIxA5R5fll0g==", + "dev": true + }, "node_modules/meow": { "version": "8.1.2", "resolved": "https://registry.npmjs.org/meow/-/meow-8.1.2.tgz", @@ -9535,6 +9714,30 @@ "url": "https://github.com/sponsors/isaacs" } }, + "node_modules/run-con": { + "version": "1.2.11", + "resolved": "https://registry.npmjs.org/run-con/-/run-con-1.2.11.tgz", + "integrity": "sha512-NEMGsUT+cglWkzEr4IFK21P4Jca45HqiAbIIZIBdX5+UZTB24Mb/21iNGgz9xZa8tL6vbW7CXmq7MFN42+VjNQ==", + "dev": true, + "dependencies": { + "deep-extend": "^0.6.0", + "ini": "~3.0.0", + "minimist": "^1.2.6", + "strip-json-comments": "~3.1.1" + }, + "bin": { + "run-con": "cli.js" + } + }, + "node_modules/run-con/node_modules/ini": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/ini/-/ini-3.0.1.tgz", + "integrity": "sha512-it4HyVAUTKBc6m8e1iXWvXSTdndF7HbdN713+kvLrymxTaU4AUBWrJ4vEooP+V7fexnVD3LKcBshjGGPefSMUQ==", + "dev": true, + "engines": { + "node": "^12.13.0 || ^14.15.0 || >=16.0.0" + } + }, "node_modules/run-parallel": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", @@ -10462,6 +10665,12 @@ "node": ">=4.2.0" } }, + "node_modules/uc.micro": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz", + "integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==", + "dev": true + }, "node_modules/uglify-js": { "version": "3.17.4", "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.17.4.tgz", @@ -14001,6 +14210,12 @@ "integrity": "sha512-Q6fKUPqnAHAyhiUgFU7BUzLiv0kd8saH9al7tnu5Q/okj6dnupxyTgFIBjVzJATdfIAm9NAsvXNzjaKa+bxVyA==", "dev": true }, + "deep-extend": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", + "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", + "dev": true + }, "deep-is": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", @@ -14932,6 +15147,12 @@ } } }, + "get-stdin": { + "version": "9.0.0", + "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-9.0.0.tgz", + "integrity": "sha512-dVKBjfWisLAicarI2Sf+JuBE/DghV4UzNAVe9yhEJuzeREd3JhOTE9cUaJTeSa77fsbQUK3pcOpJfM59+VKZaA==", + "dev": true + }, "get-stream": { "version": "6.0.1", "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz", @@ -15247,9 +15468,9 @@ } }, "ignore": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.0.tgz", - "integrity": "sha512-CmxgYGiEPCLhfLnpPp1MoRmifwEIOgjcHXxOBjv7mY96c+eWScsOP9c112ZyLdWHi0FxHjI+4uVhKYp/gcdRmQ==", + "version": "5.2.4", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.4.tgz", + "integrity": "sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ==", "dev": true }, "import-fresh": { @@ -16813,6 +17034,12 @@ "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", "dev": true }, + "jsonc-parser": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.2.0.tgz", + "integrity": "sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==", + "dev": true + }, "jsonfile": { "version": "6.1.0", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", @@ -16905,6 +17132,15 @@ "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", "dev": true }, + "linkify-it": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-4.0.1.tgz", + "integrity": "sha512-C7bfi1UZmoj8+PQx22XyeXCuBlokoyWQL5pWSP+EI6nzRylyThouddufc2c1NDIcP9k5agmN9fLpA7VNJfIiqw==", + "dev": true, + "requires": { + "uc.micro": "^1.0.1" + } + }, "lint-staged": { "version": "13.1.0", "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-13.1.0.tgz", @@ -17257,6 +17493,119 @@ "integrity": "sha512-hdN1wVrZbb29eBGiGjJbeP8JbKjq1urkHJ/LIP/NY48MZ1QVXUsQBV1G1zvYFHn1XE06cwjBsOI2K3Ulnj1YXQ==", "dev": true }, + "markdown-it": { + "version": "13.0.1", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-13.0.1.tgz", + "integrity": "sha512-lTlxriVoy2criHP0JKRhO2VDG9c2ypWCsT237eDiLqi09rmbKoUetyGHq2uOIRoRS//kfoJckS0eUzzkDR+k2Q==", + "dev": true, + "requires": { + "argparse": "^2.0.1", + "entities": "~3.0.1", + "linkify-it": "^4.0.1", + "mdurl": "^1.0.1", + "uc.micro": "^1.0.5" + }, + "dependencies": { + "argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true + }, + "entities": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-3.0.1.tgz", + "integrity": "sha512-WiyBqoomrwMdFG1e0kqvASYfnlb0lp8M5o5Fw2OFq1hNZxxcNk8Ik0Xm7LxzBhuidnZB/UtBqVCgUz3kBOP51Q==", + "dev": true + } + } + }, + "markdownlint": { + "version": "0.27.0", + "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.27.0.tgz", + "integrity": "sha512-HtfVr/hzJJmE0C198F99JLaeada+646B5SaG2pVoEakLFI6iRGsvMqrnnrflq8hm1zQgwskEgqSnhDW11JBp0w==", + "dev": true, + "requires": { + "markdown-it": "13.0.1" + } + }, + "markdownlint-cli": { + "version": "0.33.0", + "resolved": "https://registry.npmjs.org/markdownlint-cli/-/markdownlint-cli-0.33.0.tgz", + "integrity": "sha512-zMK1oHpjYkhjO+94+ngARiBBrRDEUMzooDHBAHtmEIJ9oYddd9l3chCReY2mPlecwH7gflQp1ApilTo+o0zopQ==", + "dev": true, + "requires": { + "commander": "~9.4.1", + "get-stdin": "~9.0.0", + "glob": "~8.0.3", + "ignore": "~5.2.4", + "js-yaml": "^4.1.0", + "jsonc-parser": "~3.2.0", + "markdownlint": "~0.27.0", + "minimatch": "~5.1.2", + "run-con": "~1.2.11" + }, + "dependencies": { + "argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true + }, + "brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "requires": { + "balanced-match": "^1.0.0" + } + }, + "commander": { + "version": "9.4.1", + "resolved": "https://registry.npmjs.org/commander/-/commander-9.4.1.tgz", + "integrity": "sha512-5EEkTNyHNGFPD2H+c/dXXfQZYa/scCKasxWcXJaWnNJ99pnQN9Vnmqow+p+PlFPE63Q6mThaZws1T+HxfpgtPw==", + "dev": true + }, + "glob": { + "version": "8.0.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-8.0.3.tgz", + "integrity": "sha512-ull455NHSHI/Y1FqGaaYFaLGkNMMJbavMrEGFXG/PGrg6y7sutWHUHrz6gy6WEBH6akM1M414dWKCNs+IhKdiQ==", + "dev": true, + "requires": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^5.0.1", + "once": "^1.3.0" + } + }, + "js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "dev": true, + "requires": { + "argparse": "^2.0.1" + } + }, + "minimatch": { + "version": "5.1.6", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz", + "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==", + "dev": true, + "requires": { + "brace-expansion": "^2.0.1" + } + } + } + }, + "mdurl": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", + "integrity": "sha512-/sKlQJCBYVY9Ers9hqzKou4H6V5UWc/M59TH2dvkt+84itfnq7uFOMLpOiOS4ujvHP4etln18fmIxA5R5fll0g==", + "dev": true + }, "meow": { "version": "8.1.2", "resolved": "https://registry.npmjs.org/meow/-/meow-8.1.2.tgz", @@ -18125,6 +18474,26 @@ "glob": "^7.1.3" } }, + "run-con": { + "version": "1.2.11", + "resolved": "https://registry.npmjs.org/run-con/-/run-con-1.2.11.tgz", + "integrity": "sha512-NEMGsUT+cglWkzEr4IFK21P4Jca45HqiAbIIZIBdX5+UZTB24Mb/21iNGgz9xZa8tL6vbW7CXmq7MFN42+VjNQ==", + "dev": true, + "requires": { + "deep-extend": "^0.6.0", + "ini": "~3.0.0", + "minimist": "^1.2.6", + "strip-json-comments": "~3.1.1" + }, + "dependencies": { + "ini": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/ini/-/ini-3.0.1.tgz", + "integrity": "sha512-it4HyVAUTKBc6m8e1iXWvXSTdndF7HbdN713+kvLrymxTaU4AUBWrJ4vEooP+V7fexnVD3LKcBshjGGPefSMUQ==", + "dev": true + } + } + }, "run-parallel": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", @@ -18795,6 +19164,12 @@ "integrity": "sha512-C0I1UsrrDHo2fYI5oaCGbSejwX4ch+9Y5jTQELvovfmFkK3HHSZJB8MSJcWLmCUBzQBchCrZ9rMRV6GuNrvGtw==", "dev": true }, + "uc.micro": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz", + "integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==", + "dev": true + }, "uglify-js": { "version": "3.17.4", "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.17.4.tgz", diff --git a/package.json b/package.json index fdc3a05..02b44db 100644 --- a/package.json +++ b/package.json @@ -63,6 +63,8 @@ "jest": "^28.1.3", "jest-environment-jsdom": "^29.0.1", "lint-staged": "^13.1.0", + "markdownlint": "^0.27.0", + "markdownlint-cli": "^0.33.0", "prettier": "^2.5.0", "ts-jest": "^28.0.8", "ts-node": "^10.9.1", @@ -80,4 +82,4 @@ "Vertical Timeline", "Vertical Timeline Component React" ] -} \ No newline at end of file +} From 4547e0febce7a94d3b7bd140f66070d918d8bda0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eduardo=20Esteban=20Alvarez=20Casta=C3=B1eda?= Date: Tue, 24 Jan 2023 14:29:40 -0300 Subject: [PATCH 2/8] chore(release): 4.4.2 --- CHANGELOG.md | 8 ++++++++ package-lock.json | 4 ++-- package.json | 2 +- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e69de29..e3c7973 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -0,0 +1,8 @@ +## [4.4.2](https://github.com/Proskynete/vertical-timeline-component-react/compare/v4.3.4...v4.4.2) (2023-01-24) + + +### Bug Fixes + +* husky, lint-staged and lint-commit config ([b881104](https://github.com/Proskynete/vertical-timeline-component-react/commit/b881104ec1f8a6b9c19bc197dc29583b3d6a7d21)) +* readme documentation ([6fbc62f](https://github.com/Proskynete/vertical-timeline-component-react/commit/6fbc62f9704c8d90f3280fa8a082dc349e9d84ba)) + diff --git a/package-lock.json b/package-lock.json index 6045c7a..5fa166e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "vertical-timeline-component-react", - "version": "4.4.1", + "version": "4.4.2", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "vertical-timeline-component-react", - "version": "4.4.1", + "version": "4.4.2", "license": "MIT", "dependencies": { "react": "^17.0.2", diff --git a/package.json b/package.json index 02b44db..008f96a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "vertical-timeline-component-react", - "version": "4.4.1", + "version": "4.4.2", "description": "A simple component for create a vertical timeline with React", "main": "./lib/cjs/index.js", "module": "./lib/esm/index.js", From 34cd3c9923cd6e6408157837a96387607c21daad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eduardo=20Esteban=20Alvarez=20Casta=C3=B1eda?= Date: Tue, 24 Jan 2023 23:38:19 -0300 Subject: [PATCH 3/8] fix: modify hooks scripts --- .lintstagedrc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.lintstagedrc b/.lintstagedrc index 0b60f8a..93a4096 100644 --- a/.lintstagedrc +++ b/.lintstagedrc @@ -1,10 +1,10 @@ { "*.{ts,tsx,js,jsx}": [ "npm run lint:fix", - "git add" + "git add ." ], - ".md": [ + "*.md": [ "markdownlint --fix", - "git add" + "git add ." ] } \ No newline at end of file From 3252e75833d6b994d7b495deab4a5cfbac3a2985 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eduardo=20Esteban=20Alvarez=20Casta=C3=B1eda?= Date: Tue, 24 Jan 2023 23:38:48 -0300 Subject: [PATCH 4/8] chore(release): 4.4.3 --- CHANGELOG.md | 33 +++++++++++++++++++++++++++++++++ package-lock.json | 4 ++-- package.json | 2 +- 3 files changed, 36 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e3c7973..5cad7dc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,36 @@ +## 4.4.3 (2023-01-25) + + +### Features + +* new version ([21193f6](https://github.com/Proskynete/vertical-timeline-component-react/commit/21193f683252fc9b97b91af6334c44b45125c665)) +* Use toLocaleDateString API for transform date using custom lang ([8590988](https://github.com/Proskynete/vertical-timeline-component-react/commit/85909880343144c856cc2f8f55f8bbe8ed3ffaf2)) + + +### Bug Fixes + +* Add styles and documentation for turkish translation ([7703bca](https://github.com/Proskynete/vertical-timeline-component-react/commit/7703bcaf608bb8df31f544ba1affc96600488688)) +* change custom funding url ([4b8a37d](https://github.com/Proskynete/vertical-timeline-component-react/commit/4b8a37dfae740f714c6d69e398ce68506d6a8f55)) +* change licence document to MIT and return interfaces from main route ([a336cc4](https://github.com/Proskynete/vertical-timeline-component-react/commit/a336cc4e94ff220137b157038939dd4b70a2b872)) +* Change project - now use typescript ([8341264](https://github.com/Proskynete/vertical-timeline-component-react/commit/8341264e3445b380e584f106fd55c89fa746593b)) +* Change replaceAll for replace ([392ff25](https://github.com/Proskynete/vertical-timeline-component-react/commit/392ff25a15029d5aeffe2f17e21ee12bcb6caebf)) +* error in ci github action ([df457a7](https://github.com/Proskynete/vertical-timeline-component-react/commit/df457a7dd41c9dd67b13ab1f3ba7913020f05323)) +* error on react and react-dom dependencies ([7c796e9](https://github.com/Proskynete/vertical-timeline-component-react/commit/7c796e96a37aafc962c4354702ba57b4129cc2d2)) +* github action ([cd65a5d](https://github.com/Proskynete/vertical-timeline-component-react/commit/cd65a5d5b016960bfde09308e0c44c3fd40ce723)) +* github action ([60ee3ec](https://github.com/Proskynete/vertical-timeline-component-react/commit/60ee3ec791237d37383507650cb77b275fed496e)) +* github action ([e0a65b4](https://github.com/Proskynete/vertical-timeline-component-react/commit/e0a65b4d7b9104fd402c2110248733d76540fee1)) +* husky, lint-staged and lint-commit config ([b881104](https://github.com/Proskynete/vertical-timeline-component-react/commit/b881104ec1f8a6b9c19bc197dc29583b3d6a7d21)) +* modify hooks scripts ([34cd3c9](https://github.com/Proskynete/vertical-timeline-component-react/commit/34cd3c9923cd6e6408157837a96387607c21daad)) +* readme documentation ([6fbc62f](https://github.com/Proskynete/vertical-timeline-component-react/commit/6fbc62f9704c8d90f3280fa8a082dc349e9d84ba)) +* readme documentation ([18a6103](https://github.com/Proskynete/vertical-timeline-component-react/commit/18a6103f03fea89a6963f27d4ca2dfe4885c43cd)) +* **snapshot:** update snapshot ([c2743b6](https://github.com/Proskynete/vertical-timeline-component-react/commit/c2743b63807d806257f4e7fdd559e31341cb3594)) +* some compile errors ([1e1af35](https://github.com/Proskynete/vertical-timeline-component-react/commit/1e1af35e61470f51fb898b26e59f20d0ce806bed)) +* Styles ([a9f71e9](https://github.com/Proskynete/vertical-timeline-component-react/commit/a9f71e95075e247cd966a265f8d8c1c9711345f7)) +* styles and funding.yml file ([9e73e6c](https://github.com/Proskynete/vertical-timeline-component-react/commit/9e73e6cd7207f274f17b593a10835251f3b64b78)) +* Styles when lang as '_' or '-' symbols ([cdc8a08](https://github.com/Proskynete/vertical-timeline-component-react/commit/cdc8a08f332eba6c60c78f86d770288f4cb13d87)) +* **title-overlap:** fix title styles ([29a70fc](https://github.com/Proskynete/vertical-timeline-component-react/commit/29a70fc57753ded2ebbd6b833cf22f5ce3c0428e)) +* titles width ([c284e6e](https://github.com/Proskynete/vertical-timeline-component-react/commit/c284e6e9e1547b37eb12f47c2b67a304d613776f)) + ## [4.4.2](https://github.com/Proskynete/vertical-timeline-component-react/compare/v4.3.4...v4.4.2) (2023-01-24) diff --git a/package-lock.json b/package-lock.json index 5fa166e..1980304 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "vertical-timeline-component-react", - "version": "4.4.2", + "version": "4.4.3", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "vertical-timeline-component-react", - "version": "4.4.2", + "version": "4.4.3", "license": "MIT", "dependencies": { "react": "^17.0.2", diff --git a/package.json b/package.json index 008f96a..4acc065 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "vertical-timeline-component-react", - "version": "4.4.2", + "version": "4.4.3", "description": "A simple component for create a vertical timeline with React", "main": "./lib/cjs/index.js", "module": "./lib/esm/index.js", From 89b2fa4d22aadef0afda81438123a63015aef390 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eduardo=20Esteban=20Alvarez=20Casta=C3=B1eda?= Date: Sun, 14 Apr 2024 02:23:15 -0400 Subject: [PATCH 5/8] chore: update funding file --- .github/funding.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/funding.yml b/.github/funding.yml index f040bbe..d468d58 100644 --- a/.github/funding.yml +++ b/.github/funding.yml @@ -1,2 +1,3 @@ github: Proskynete -custom: https://thanks.eduardoalvarez.dev/donate \ No newline at end of file +custom: https://eduardoalvarez.dev/donaciones +buy_me_a_coffee: eduardoalvarez.dev From 5531f2cf0dfe2e2a6309aa2a130ee3c9901ba499 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eduardo=20Esteban=20Alvarez=20Casta=C3=B1eda?= Date: Sun, 14 Apr 2024 02:24:39 -0400 Subject: [PATCH 6/8] chore: update readme file --- README.md | 156 +++++++++++++++++++++++++++--------------------------- 1 file changed, 78 insertions(+), 78 deletions(-) diff --git a/README.md b/README.md index aa54812..bac60f8 100644 --- a/README.md +++ b/README.md @@ -57,13 +57,13 @@ This is the wrapper component that creates the vertical timeline. - Props -| name | Type | Required | Values Allowed | default values | Description | -| ---------- | ------- | -------- | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| theme | `object` | `false` | `colors` | { borderDotColor: '#ffffff', descriptionColor: '#cccccc', dotColor: '#c5c5c5', eventColor: '#cccccc', lineColor: '#c5c5c5', subtitleColor: '#c5c5c5', titleColor: '#cccccc', yearColor: '#888888' } | Set colors in all components | -| lang | `string` | `false` | `en`, `es`, `de`, `tr` or `zh` | `en` | Change the language `from` and `to` texts and change the format in the dates | -| dateFormat | `string` | `false` | `only-number`, `short`, `with-weekday` or `full` | `only-number` | Change the presentation format of dates | -| collapse | `boolean` | `false` | `true` or `false` | `false` | Allow collapsing description of all Content components | -| withoutDay | `boolean` | `false` | `true` or `false` | `false` | Will hide the day of the dates of all Content components | +| name | Type | Required | Values Allowed | default values | Description | +| ---------- | --------- | -------- | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| theme | `object` | `false` | `colors` | { borderDotColor: '#ffffff', descriptionColor: '#cccccc', dotColor: '#c5c5c5', eventColor: '#cccccc', lineColor: '#c5c5c5', subtitleColor: '#c5c5c5', titleColor: '#cccccc', yearColor: '#888888' } | Set colors in all components | +| lang | `string` | `false` | `en`, `es`, `de`, `tr` or `zh` | `en` | Change the language `from` and `to` texts and change the format in the dates | +| dateFormat | `string` | `false` | `only-number`, `short`, `with-weekday` or `full` | `only-number` | Change the presentation format of dates | +| collapse | `boolean` | `false` | `true` or `false` | `false` | Allow collapsing description of all Content components | +| withoutDay | `boolean` | `false` | `true` or `false` | `false` | Will hide the day of the dates of all Content components | `dateFormat`: The next table shows the different formats that can be used in the `dateFormat` prop and the result that will be displayed. @@ -89,14 +89,14 @@ This component is the container of the content of each year. It is required to h - Props -| Name | Type | Required | Values Allowed | default values | Description | -| ------------- | ------- | -------- | --------------------------------- | -------------- | -------------------------------------------------------------------------------- | -| title | `string`, `JSX.Element` | `true` | any string, or some component | does not apply | The title of this block time | -| startDate | `string` | `true` | `YYYY/MM/DD` - `YYYY/MM` - `YYYY` | does not apply | The date of the start of the content or contents | -| endDate | `string` | `false` | `YYYY/MM/DD` - `YYYY/MM` - `YYYY` | does not apply | The date of the end of the content or contents | -| active | `boolean` | `false` | `true` or `false` | `false` | The value is the current year, it is recommended to use it in the last Container | -| withoutDay | `boolean` | `false` | `true` or `false` | `false` | Will hide the day of the dates for this component only | -| defaultClosed | `boolean` | `false` | `true` or `false` | `false` | Will collapse the content of this component only | +| Name | Type | Required | Values Allowed | default values | Description | +| ------------- | ----------------------- | -------- | --------------------------------- | -------------- | -------------------------------------------------------------------------------- | +| title | `string`, `JSX.Element` | `true` | any string, or some component | does not apply | The title of this block time | +| startDate | `string` | `true` | `YYYY/MM/DD` - `YYYY/MM` - `YYYY` | does not apply | The date of the start of the content or contents | +| endDate | `string` | `false` | `YYYY/MM/DD` - `YYYY/MM` - `YYYY` | does not apply | The date of the end of the content or contents | +| active | `boolean` | `false` | `true` or `false` | `false` | The value is the current year, it is recommended to use it in the last Container | +| withoutDay | `boolean` | `false` | `true` or `false` | `false` | Will hide the day of the dates for this component only | +| defaultClosed | `boolean` | `false` | `true` or `false` | `false` | Will collapse the content of this component only |

🔝

@@ -106,10 +106,10 @@ For each `Events` you need one or more `Event` component. - Props -| Name | Type | Required | Description | -| ----------- | ---------------- | -------- | ---------------------------------------------------------------------------------- | -| title | `string` | `false` | It's the title of one or many descriptions | -| description | `array` of `strings` | `true` | You can write anything you want, but remember that it is consistent with the title | +| Name | Type | Required | Description | +| ----------- | -------------------- | -------- | ---------------------------------------------------------------------------------- | +| title | `string` | `false` | It's the title of one or many descriptions | +| description | `array` of `strings` | `true` | You can write anything you want, but remember that it is consistent with the title | > If the title is not defined (or empty), the description will always be displayed even when the defaultClosed prop is in the Events component @@ -125,38 +125,38 @@ The following snippet will show you how to use the library: import { Timeline, Events, Event } from 'vertical-timeline-component-react'; const customTheme = { - borderDotColor: '#ffffff', - descriptionColor: '#262626', - dotColor: '#d0cdc4', - eventColor: '#965500', - lineColor: '#d0cdc4', - subtitleColor: '#7c7c7c', - titleColor: '#405b73', - yearColor: '#405b73', + borderDotColor: '#ffffff', + descriptionColor: '#262626', + dotColor: '#d0cdc4', + eventColor: '#965500', + lineColor: '#d0cdc4', + subtitleColor: '#7c7c7c', + titleColor: '#405b73', + yearColor: '#405b73', }; class Main extends Component { - render() { - return ( - - What is lorem Ipsum?} - subtitle="It's a fake text" - startDate="2020/12/02" - defaultClosed - active - > - - - - ); - } + render() { + return ( + + What is lorem Ipsum?} + subtitle="It's a fake text" + startDate="2020/12/02" + defaultClosed + active + > + + + + ); + } } ``` @@ -166,36 +166,36 @@ class Main extends Component { import { Timeline, Events, Event } from 'vertical-timeline-component-react'; const Main = () => { - const customTheme = { - borderDotColor: '#ffffff', - descriptionColor: '#262626', - dotColor: '#d0cdc4', - eventColor: '#965500', - lineColor: '#d0cdc4', - subtitleColor: '#7c7c7c', - titleColor: '#405b73', - yearColor: '#405b73', - }; - - return ( - - - - - - ); + const customTheme = { + borderDotColor: '#ffffff', + descriptionColor: '#262626', + dotColor: '#d0cdc4', + eventColor: '#965500', + lineColor: '#d0cdc4', + subtitleColor: '#7c7c7c', + titleColor: '#405b73', + yearColor: '#405b73', + }; + + return ( + + + + + + ); }; ``` From 76cb04f963eafa371777d5daaf769b2407d2217f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eduardo=20Esteban=20Alvarez=20Casta=C3=B1eda?= Date: Sun, 14 Apr 2024 02:31:42 -0400 Subject: [PATCH 7/8] chore: update tests --- .../timeline/__snapshots__/index.test.tsx.snap | 12 ++++++------ tests/helpers/transform-date.helper.test.ts | 4 ++-- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/tests/components/timeline/__snapshots__/index.test.tsx.snap b/tests/components/timeline/__snapshots__/index.test.tsx.snap index 4d41859..deb3ee1 100644 --- a/tests/components/timeline/__snapshots__/index.test.tsx.snap +++ b/tests/components/timeline/__snapshots__/index.test.tsx.snap @@ -15,16 +15,16 @@ Object { class="sc-dkzDqf bqgjsq" >