Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: lumirlumir/npm-textlint-rule-allowed-uris
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v1.0.3
Choose a base ref
...
head repository: lumirlumir/npm-textlint-rule-allowed-uris
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: v1.0.4
Choose a head ref
  • 10 commits
  • 13 files changed
  • 2 contributors

Commits on Sep 2, 2024

  1. ci: update .github/sync-client.yml for new sync file (#57)

    lumirlumir authored Sep 2, 2024

    Verified

    This commit was signed with the committer’s verified signature.
    sdispater Sébastien Eustace
    Copy the full SHA
    c960edb View commit details

Commits on Sep 7, 2024

  1. docs: update README.md (#58)

    * docs: update README.md
    
    * Update README.md
    
    * Update README.md
    
    * docs: update README.md
    lumirlumir authored Sep 7, 2024
    Copy the full SHA
    bd6044c View commit details

Commits on Sep 9, 2024

  1. build(deps-dev): bump eslint-plugin-import from 2.29.1 to 2.30.0 (#60)

    Bumps [eslint-plugin-import](https://github.com/import-js/eslint-plugin-import) from 2.29.1 to 2.30.0.
    - [Release notes](https://github.com/import-js/eslint-plugin-import/releases)
    - [Changelog](https://github.com/import-js/eslint-plugin-import/blob/main/CHANGELOG.md)
    - [Commits](import-js/eslint-plugin-import@v2.29.1...v2.30.0)
    
    ---
    updated-dependencies:
    - dependency-name: eslint-plugin-import
      dependency-type: direct:development
      update-type: version-update:semver-minor
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 9, 2024
    Copy the full SHA
    0e137d3 View commit details
  2. build(deps-dev): bump concurrently from 8.2.2 to 9.0.0 (#59)

    Bumps [concurrently](https://github.com/open-cli-tools/concurrently) from 8.2.2 to 9.0.0.
    - [Release notes](https://github.com/open-cli-tools/concurrently/releases)
    - [Commits](open-cli-tools/concurrently@v8.2.2...v9.0.0)
    
    ---
    updated-dependencies:
    - dependency-name: concurrently
      dependency-type: direct:development
      update-type: version-update:semver-major
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    Co-authored-by: 루밀LuMir <rpfos@naver.com>
    dependabot[bot] and lumirlumir authored Sep 9, 2024
    Copy the full SHA
    c89a22b View commit details

Commits on Sep 10, 2024

  1. sync-server: synced file(s) with lumirlumir/lumirlumir-configs (#61)

    * sync-server: synced local './.github/ISSUE_TEMPLATE/bug.md' with remote './configs/.github/ISSUE_TEMPLATE/bug.md'
    
    * sync-server: synced local './.github/workflows/bump.yml' with remote './configs/.github/workflows/bump.yml'
    
    * sync-server: synced local './.github/workflows/labeler.yml' with remote './configs/.github/workflows/labeler.yml'
    
    * sync-server: synced local './.github/workflows/lint.yml' with remote './configs/.github/workflows/lint.yml'
    
    * sync-server: synced local './.github/workflows/sync-client.yml' with remote './configs/.github/workflows/sync-client.yml'
    
    * sync-server: synced local './.github/PULL_REQUEST_TEMPLATE.md' with remote './configs/.github/PULL_REQUEST_TEMPLATE.md'
    
    * sync-server: synced local './.github/release.yml' with remote './configs/.github/release.yml'
    lumirlumir authored Sep 10, 2024
    Copy the full SHA
    888a2a4 View commit details

Commits on Sep 14, 2024

  1. sync-server: synced file(s) with lumirlumir/lumirlumir-configs (#62)

    * sync-server: synced local './.vscode/settings.json' with remote './configs/.vscode/settings.json'
    
    * sync-server: synced local './.prettierignore' with remote './configs/.prettierignore'
    lumirlumir authored Sep 14, 2024
    Copy the full SHA
    675352c View commit details

Commits on Sep 16, 2024

  1. build(deps-dev): bump husky from 9.1.5 to 9.1.6 (#63)

    Bumps [husky](https://github.com/typicode/husky) from 9.1.5 to 9.1.6.
    - [Release notes](https://github.com/typicode/husky/releases)
    - [Commits](typicode/husky@v9.1.5...v9.1.6)
    
    ---
    updated-dependencies:
    - dependency-name: husky
      dependency-type: direct:development
      update-type: version-update:semver-patch
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 16, 2024
    Copy the full SHA
    b4141ed View commit details
  2. build(deps-dev): bump concurrently from 9.0.0 to 9.0.1 (#64)

    Bumps [concurrently](https://github.com/open-cli-tools/concurrently) from 9.0.0 to 9.0.1.
    - [Release notes](https://github.com/open-cli-tools/concurrently/releases)
    - [Commits](open-cli-tools/concurrently@v9.0.0...v9.0.1)
    
    ---
    updated-dependencies:
    - dependency-name: concurrently
      dependency-type: direct:development
      update-type: version-update:semver-patch
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    dependabot[bot] authored Sep 16, 2024
    Copy the full SHA
    900e95c View commit details
  3. sync-server: synced local './.github/workflows/bump.yml' with remote …

    …'./configs/.github/workflows/bump.yml' (#67)
    lumirlumir authored Sep 16, 2024
    Copy the full SHA
    030b808 View commit details
  4. release(patch): v1.0.4 (#68)

    lumirlumir authored Sep 16, 2024
    Copy the full SHA
    10b272b View commit details
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -22,7 +22,7 @@ title: 'Bug: '
Link to code example:

<!--
Please provide a CodeSandbox, a link to a repository on GitHub, or provide a minimal code example that reproduces the problem.
Provide a CodeSandbox, link to a repository on GitHub, or minimal code example that reproduces the problem.
You may provide a screenshot of the application if you think it is relevant to your bug report.
Here are some tips for providing a minimal example: https://stackoverflow.com/help/mcve.
-->
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@
Thanks for submitting a pull request!
We appreciate you spending the time to work on these changes.
Please provide enough information so that others can review your pull request.
Before making a pull request, please read our contributing guidelines in `README.md`.
Before making a pull request, read our contributing guidelines in `README.md`.
-->

# Title
4 changes: 2 additions & 2 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ changelog:
labels:
- feat

- title: 🐛 Bugfixes
- title: 🐛 Bug Fixes
labels:
- fix

@@ -28,7 +28,7 @@ changelog:
labels:
- test

- title: ⬆️ Dependency updates
- title: ⬆️ Dependency Updates
labels:
- dependencies

2 changes: 2 additions & 0 deletions .github/sync-client.yml
Original file line number Diff line number Diff line change
@@ -9,6 +9,8 @@ lumirlumir/lumirlumir-configs:
- source: ./.github/ISSUE_TEMPLATE/suggestion.md
dest: ./configs/.github/ISSUE_TEMPLATE/suggestion.md
# ./.github/workflows
- source: ./.github/workflows/bump.yml
dest: ./configs/.github/workflows/bump.yml
- source: ./.github/workflows/labeler.yml
dest: ./configs/.github/workflows/labeler.yml
- source: ./.github/workflows/lint.yml
25 changes: 10 additions & 15 deletions .github/workflows/bump.yml
Original file line number Diff line number Diff line change
@@ -2,10 +2,10 @@ on:
workflow_dispatch:
inputs:
type:
description: 'Select the type of version bump'
description: Select the type of version bump
required: true
type: choice
default: 'patch'
default: patch
options:
- patch
- minor
@@ -37,28 +37,23 @@ jobs:
- name: Set up node_modules
run: npm ci

- name: Set up SHA
run: echo "SHORT_SHA=${GITHUB_SHA:0:7}" >> $GITHUB_ENV

- name: Set up old version
run: echo "OLD_VERSION=$(node -p "require('./package.json').version")" >> $GITHUB_ENV

- name: Set up github
- name: Set up environment variables
run: |
git config --global user.name 'github-actions'
git config --global user.email 'actions@github.com'
git switch -c release-${{ inputs.type }}-${{ env.SHORT_SHA }}
echo "SHORT_SHA=${GITHUB_SHA:0:7}" >> $GITHUB_ENV
echo "OLD_VERSION=$(node -p "require('./package.json').version")" >> $GITHUB_ENV
- name: Bump
run: |
git config --global user.name '루밀LuMir'
git config --global user.email 'rpfos@naver.com'
git switch -c release-${{ inputs.type }}-${{ env.SHORT_SHA }}
npm version ${{ inputs.type }} -m "release(${{ inputs.type }}): v%s"
- name: Set up new version
- name: Set up environment variables
run: echo "NEW_VERSION=$(node -p "require('./package.json').version")" >> $GITHUB_ENV

- name: Push
run: |
git push --set-upstream origin release-${{ inputs.type }}-${{ env.SHORT_SHA }}
run: git push --set-upstream origin release-${{ inputs.type }}-${{ env.SHORT_SHA }}

- name: Create pull request
run: |
4 changes: 0 additions & 4 deletions .github/workflows/labeler.yml
Original file line number Diff line number Diff line change
@@ -8,10 +8,6 @@ jobs:
labeler:
runs-on: ubuntu-latest

permissions:
contents: read
pull-requests: write

steps:
- name: Labeler
uses: jimschubert/labeler-action@v2
11 changes: 0 additions & 11 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -9,14 +9,6 @@ on:

jobs:
lint:
# strategy:
# matrix:
# type:
# - eslint
# - prettier
# - editorconfig
# - markdownlint

runs-on: ubuntu-latest

steps:
@@ -40,6 +32,3 @@ jobs:

- name: Lint
run: npm run lint

# - name: Lint ${{ matrix.type }}
# run: npm run lint-${{ matrix.type }} --if-present
3 changes: 1 addition & 2 deletions .github/workflows/sync-client.yml
Original file line number Diff line number Diff line change
@@ -12,7 +12,7 @@ jobs:
- name: Set up checkout
uses: actions/checkout@v4

- name: Set up SHA
- name: Set up environment variables
run: echo "SHORT_SHA=${GITHUB_SHA:0:7}" >> $GITHUB_ENV

- name: Sync
@@ -24,4 +24,3 @@ jobs:
ASSIGNEES: ${{ github.repository_owner }}
COMMIT_PREFIX: ${{ github.workflow }}${{':'}}
PR_BODY: check out [`${{ env.SHORT_SHA }}`](https://github.com/${{ github.repository }}/commit/${{ github.sha }}) @${{ github.repository_owner }} :hatching_chick:.
# See https://docs.github.com/ko/actions/writing-workflows/choosing-what-your-workflow-does/contexts#github-context for more detailed context
4 changes: 4 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -19,3 +19,7 @@ package-lock.json

# markdown
*.md

# cpp
*.c
*.cpp
6 changes: 5 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -2,10 +2,14 @@
"editor.formatOnSave": true,
"editor.formatOnPaste": true,
"editor.defaultFormatter": "esbenp.prettier-vscode",
"[c][cpp]": {
"editor.defaultFormatter": "ms-vscode.cpptools"
},
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "always",
"source.fixAll.stylelint": "always",
"source.fixAll.markdownlint": "always"
},
"stylelint.validate": ["css", "scss"]
"stylelint.validate": ["css", "scss"],
"C_Cpp.clang_format_fallbackStyle": "Google"
}
34 changes: 15 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -30,16 +30,15 @@ You can use any ***link*** or ***image*** formats which are supported by Markdow

### Only URIs are inspected?

No! We check not only for URIs, but also for **local paths**! Below patterns are inspected too.
No! We check not only for URIs, but also for **local paths**. Below patterns are inspected too.

```text
README.md (Relative path)
/README.md (Absolute path)
../README.md (Relative path)
/learn/start-a-new-react-project#can-i-use-react-without-a-framework (With hash)
/images/languages/javascript/composition-of-javascript/2.png?raw=true (With query parameters)
And more!!!
And more...
```

### Patterns
@@ -52,15 +51,15 @@ Only **regular expressions** are used for URIs pattern matching. You can define
Allowed URIs act like an <u>**whitelist**</u>. Only those written on the whitelist **can** pass through.

For example, If you pass an empty array to the option, it allows nothing. i.e. Every ***links*** or ***images*** will be detected. (For a detailed explanation, see [Configs](#configs))
For example, If you pass an empty array to the option, it allows nothing. i.e. Every ***links*** or ***images*** will be detected. (For a detailed explanation, see [Configs](#configs).)

### Disallowed URIs

> Related: `disallowed.links`, `disallowed.images`
On the contrary, disallowed URIs act like an <u>**blacklist**</u>. Only those written on the blacklist **cannot** pass through.

For example, If you pass an empty array to the option, it allows everything. i.e. no ***links*** or ***images*** will be detected. (For a detailed explanation, see [Configs](#configs))
For example, If you pass an empty array to the option, it allows everything. i.e. no ***links*** or ***images*** will be detected. (For a detailed explanation, see [Configs](#configs).)

## Installation

@@ -153,7 +152,7 @@ Every options are optional. If you pass nothing, then nothing just happens!

1. `disallowed.links`: `RegExp[]`, Optional
- Disallowed `links` act like an <u>**blacklist**</u>. Only those written on the blacklist **cannot** pass through.
- If you want to turn off this option, then pass nothing. or here, you can pass an empty array. (because the default value passed is an empty array too😯)
- If you want to turn off this option, then pass nothing. or here, you can pass an empty array. (because the default value passed is an empty array too.)

```javascript
/* .textlintrc.js */
@@ -178,7 +177,7 @@ Every options are optional. If you pass nothing, then nothing just happens!

1. `disallowed.images`: `RegExp[]`, Optional
- Disallowed `images` act like an <u>**blacklist**</u>. Only those written on the blacklist **cannot** pass through.
- If you want to turn off this option, then pass nothing. or here, you can pass an empty array. (because the default value passed is an empty array too😯)
- If you want to turn off this option, then pass nothing. or here, you can pass an empty array. (because the default value passed is an empty array too.)

```javascript
/* .textlintrc.js */
@@ -402,18 +401,19 @@ Email links like `<example@gmail.com>` are interpreted as `mailto:example@gmail.

## Contributing

Thanks for having attention to this package.🙇‍♂️ Issues and PRs are always welcomed.🎉
Thanks for having attention to this package.🙇‍♂️ Issues and PRs are always welcome.🎉

I recommend you to read [textlint guides](https://textlint.github.io/) before contributing.

And check out the [Installation](#installation) and [Concepts of `textlint-rule-allowed-uris`](#concepts-of-textlint-rule-allowed-uris) guides below. It will help you to understand how this package works.

After that, refer to the comments in source codes. It contains a lot of useful information to help you.
After that, refer to the comments in source codes. It contains useful information to help you.

### Installation

1. Fork it.
1. Clone it to your local directory. ([Git](https://git-scm.com/downloads) is needed!)

1. Clone it to your local directory. ([Git](https://git-scm.com/downloads) is required.)

```bash
git clone https://github.com/lumirlumir/npm-textlint-rule-allowed-uris.git
@@ -425,32 +425,28 @@ After that, refer to the comments in source codes. It contains a lot of useful i
cd npm-textlint-rule-allowed-uris
```

1. Install npm packages. ([Node.js](https://nodejs.org/en) is needed!)
1. Install npm packages. ([Node.js](https://nodejs.org/en) is required.)

```bash
npm install
```

1. Edit codes.

1. Create `feature` branch.
1. Create `my-branch` branch.

```bash
git switch -c feature
git switch -c my-branch
```

1. Commit your changes. (`husky` and `lint-staged` will lint and test your changed files!)

```bash
git commit -am "feat: feature"
git commit -am "commit type: title"
```

1. Push them to your remote branch.

```bash
git push --set-upstream origin feature
```

1. Submit a pull request.👍

### Concepts of `textlint-rule-allowed-uris`
@@ -499,7 +495,7 @@ You can see detailed parsed AST Tree in [here](https://textlint.github.io/astexp

## Versioning

This project adheres to [Semantic Versioning](https://semver.org/). For details, please refer to the [`CHANGELOG.md`](/CHANGELOG.md) or [tags](https://github.com/lumirlumir/npm-textlint-rule-allowed-uris/tags).
This project adheres to [Semantic Versioning](https://semver.org/).

## Change Log

Loading