From d0d36de6ff4e7a118472eed41c94cef862d1f372 Mon Sep 17 00:00:00 2001 From: JounQin Date: Tue, 12 Mar 2024 20:31:19 +0800 Subject: [PATCH] docs: update repository url (#39) --- .changeset/five-moons-thank.md | 5 +++++ README.md | 21 ++++++++++----------- src/docsUrl.js | 2 +- test/core/docsUrl.spec.js | 4 ++-- 4 files changed, 18 insertions(+), 14 deletions(-) create mode 100644 .changeset/five-moons-thank.md diff --git a/.changeset/five-moons-thank.md b/.changeset/five-moons-thank.md new file mode 100644 index 000000000..a38f6d830 --- /dev/null +++ b/.changeset/five-moons-thank.md @@ -0,0 +1,5 @@ +--- +"eslint-plugin-import-x": patch +--- + +docs: update repository url diff --git a/README.md b/README.md index 3ea588979..dc93bb6de 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ # eslint-plugin-import-x -[![github actions][actions-image]][actions-url] -[![travis-ci](https://travis-ci.org/import-js/eslint-plugin-import.svg?branch=main)](https://travis-ci.org/import-js/eslint-plugin-import) -[![coverage][codecov-image]][codecov-url] -[![win32 build status](https://ci.appveyor.com/api/projects/status/3mw2fifalmjlqf56/branch/main?svg=true)](https://ci.appveyor.com/project/import-js/eslint-plugin-import/branch/main) -[![npm](https://img.shields.io/npm/v/eslint-plugin-import.svg)](https://www.npmjs.com/package/eslint-plugin-import) -[![npm downloads](https://img.shields.io/npm/dt/eslint-plugin-import.svg?maxAge=2592000)](https://www.npmtrends.com/eslint-plugin-import) +[![GitHub Actions](https://github.com/un-es/eslint-plugin-import-x/workflows/CI/badge.svg)](https://github.com/un-es/eslint-plugin-import-x/actions/workflows/ci.yml) +[![Codecov](https://img.shields.io/codecov/c/github/un-es/eslint-plugin-import-x.svg)](https://codecov.io/gh/un-es/eslint-plugin-import-x) +[![type-coverage](https://img.shields.io/badge/dynamic/json.svg?label=type-coverage&prefix=%E2%89%A5&suffix=%&query=$.typeCoverage.atLeast&uri=https%3A%2F%2Fraw.githubusercontent.com%2Fun-ts%2Fsynckit%2Fmain%2Fpackage.json)](https://github.com/plantain-00/type-coverage) +[![npm](https://img.shields.io/npm/v/eslint-plugin-import-x.svg)](https://www.npmjs.com/package/eslint-plugin-import-x) +[![GitHub Release](https://img.shields.io/github/release/un-es/eslint-plugin-import-x)](https://github.com/un-es/eslint-plugin-import-x/releases) + +[![Conventional Commits](https://img.shields.io/badge/conventional%20commits-1.0.0-yellow.svg)](https://conventionalcommits.org) +[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com) +[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) +[![Code Style: Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier) This plugin intends to support linting of ES2015+ (ES6+) import/export syntax, and prevent issues with misspelling of file paths and import names. All the goodness that the ES2015+ static module syntax intends to provide, marked up in your editor. @@ -488,8 +492,3 @@ In Package Settings / SublimeLinter / User Settings: I believe this defaults to `3`, so you may not need to alter it depending on your project folder max depth. - -[codecov-image]: https://codecov.io/gh/import-js/eslint-plugin-import/branch/main/graphs/badge.svg -[codecov-url]: https://app.codecov.io/gh/import-js/eslint-plugin-import/ -[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/import-js/eslint-plugin-import -[actions-url]: https://github.com/import-js/eslint-plugin-import diff --git a/src/docsUrl.js b/src/docsUrl.js index 96f0d76d5..5cccd938f 100644 --- a/src/docsUrl.js +++ b/src/docsUrl.js @@ -1,6 +1,6 @@ import pkg from '../package.json' -const repoUrl = 'https://github.com/import-js/eslint-plugin-import' +const repoUrl = 'https://github.com/un-es/eslint-plugin-import-x' export default function docsUrl(ruleName, commitish = `v${pkg.version}`) { return `${repoUrl}/blob/${commitish}/docs/rules/${ruleName}.md` diff --git a/test/core/docsUrl.spec.js b/test/core/docsUrl.spec.js index 41b1e6148..4250747d7 100644 --- a/test/core/docsUrl.spec.js +++ b/test/core/docsUrl.spec.js @@ -4,13 +4,13 @@ import docsUrl from '../../src/docsUrl' describe('docsUrl', () => { it('returns the rule documentation URL when given a rule name', () => { expect(docsUrl('foo')).toBe( - `https://github.com/import-js/eslint-plugin-import/blob/v${pkg.version}/docs/rules/foo.md`, + `https://github.com/un-es/eslint-plugin-import-x/blob/v${pkg.version}/docs/rules/foo.md`, ) }) it('supports an optional commit-ish parameter', () => { expect(docsUrl('foo', 'bar')).toBe( - 'https://github.com/import-js/eslint-plugin-import/blob/bar/docs/rules/foo.md', + 'https://github.com/un-es/eslint-plugin-import-x/blob/bar/docs/rules/foo.md', ) }) })