diff --git a/.github/CODE-OF-CONDUCT.md b/.github/CODE-OF-CONDUCT.md index efccb43f..6ed51f5a 100644 --- a/.github/CODE-OF-CONDUCT.md +++ b/.github/CODE-OF-CONDUCT.md @@ -1,73 +1,132 @@ + # Contributor Covenant Code of Conduct ## Our Pledge -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, gender identity and expression, level of experience, -nationality, personal appearance, race, religion, or sexual identity and -orientation. +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. ## Our Standards -Examples of behavior that contributes to creating a positive environment -include: +Examples of behavior that contributes to a positive environment for our +community include: -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community -Examples of unacceptable behavior by participants include: +Examples of unacceptable behavior include: -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks * Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission +* Publishing others' private information, such as a physical or email address, + without their explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting -## Our Responsibilities +## Enforcement Responsibilities -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. ## Scope -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at dmalinochkin@rambler.ru. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. +reported to the community leaders responsible for enforcement at dmalinochkin@outlook.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. [homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 2988c8f4..9898474f 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -8,46 +8,59 @@ Please note that this project is released with a [Contributor Code of Conduct](C There are a couple of ways you can contribute to this repository: - * **Ideas, feature requests and bugs**: We are open to all ideas and we want to get rid of bugs! Use the [Issues section](https://github.com/mrmlnc/fast-glob/issues) to either report a new issue, provide your ideas or contribute to existing threads. - * **Documentation**: Found a typo or strangely worded sentences? Submit a PR! - * **Code**: Contribute bug fixes, features or design changes. +* **Ideas, feature requests and bugs**: We are open to all ideas and we want to get rid of bugs! Use the [Issues section](https://github.com/mrmlnc/fast-glob/issues) to either report a new issue, provide your ideas or contribute to existing threads. +* **Documentation**: Found a typo or strangely worded sentences? Submit a PR! +* **Code**: Contribute bug fixes, features or design changes. ### Creating an Issue Before you create a new Issue: - * Check the [Issues](https://github.com/mrmlnc/fast-glob/issues) on GitHub to ensure one doesn't already exist. - * Clearly describe the issue, including the steps to reproduce the issue. +* Check the [Issues](https://github.com/mrmlnc/fast-glob/issues) on GitHub to ensure one doesn't already exist. +* Clearly describe the issue, including the steps to reproduce the issue. ### Making Changes #### Getting Started - * Install [Node.js](https://nodejs.org/en/). - * Fork the project and clone the fork repository. ([how to create fork?](https://help.github.com/articles/fork-a-repo/#fork-an-example-repository)). - * Create a topic branch from the master branch. - * Run `yarn` or `npm install` to install the application dependencies. +* Install [Node.js](https://nodejs.org/en/). +* Fork the project and clone the fork repository. ([how to create fork?](https://help.github.com/articles/fork-a-repo/#fork-an-example-repository)). +* Create a topic branch from the master branch. +* Run `npm install` to install the application dependencies. #### Setup -1. Start watching: +> 📖 Only `npm` is supported for working with this repository. Problems with other package managers will be ignored. -``` -$ npm run watch -``` +```bash +# Clone repository +git clone https://github.com/mrmlnc/fast-glob +cd fast-glob -2. Make changes: +# Install dependencies +npm install -``` -$ code . -``` +# Build package +npm run build -3. Run tests: +# Run tests +npm t +npm run test:e2e -``` -$ npm t +# Watch changes +npm run watch + +# Build bundle +npm run bundle +npm t +npm run test:e2e + +# Run benchmark +npm run bench:async +npm run bench:sync +npm run bench:stream ``` #### Commit -Keep git commit messages clear and appropriate. You can use [Angular guide](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines). +Keep git commit messages clear and appropriate. You can use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml index c66f3290..2d46a3de 100644 --- a/.github/workflows/benchmark.yml +++ b/.github/workflows/benchmark.yml @@ -2,12 +2,9 @@ name: Benchmark on: push: - branches: - - master - - releases/* + branches: ['master', 'releases/*'] pull_request: - branches: - - '*' + branches: ['*'] jobs: product: @@ -18,15 +15,15 @@ jobs: runs-on: ubuntu-latest steps: - name: Setup repository - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Setup environment - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: 20 - name: Install dependencies run: npm install - - name: Compile sources - run: npm run compile + - name: Prepare bundle + run: npm run bundle - name: Benchmark (async) run: npm run bench:product:async - name: Benchmark (stream) @@ -51,15 +48,15 @@ jobs: BENCHMARK_OPTIONS: ${{ matrix.benchmark_options }} steps: - name: Setup repository - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Setup environment - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: 20 - name: Install dependencies run: npm install - - name: Compile sources - run: npm run compile + - name: Prepare bundle + run: npm run bundle - name: Benchmark (async) run: npm run bench:regression:async - name: Benchmark (stream) diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index ff2938b8..d3122069 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -2,13 +2,9 @@ name: "CodeQL" on: push: - branches: - - master - - "!dependabot/**" + branches: ['master'] pull_request: - branches: - - master - - "!dependabot/**" + branches: ['master'] schedule: - cron: "0 0 * * 0" workflow_dispatch: @@ -27,7 +23,7 @@ jobs: steps: - name: Clone repository - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: persist-credentials: false diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 1c8d590d..4315501a 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -2,12 +2,9 @@ name: CI on: push: - branches: - - master - - releases/* + branches: ['master', 'releases/*'] pull_request: - branches: - - '*' + branches: ['*'] env: SNAPSHOT_SKIP_PRUNING: 1 @@ -29,17 +26,17 @@ jobs: - windows-latest steps: - name: Setup repository - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Setup environment - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: ${{ matrix.node_version }} - name: Install dependencies run: npm install - - name: Compile sources - run: npm run compile - name: Run Hygiene Checks run: npm run lint + - name: Prepare bundle + run: npm run bundle - name: Run unit tests run: npm run test - name: Run e2e tests (sync) diff --git a/.gitignore b/.gitignore index 76707907..e5208476 100644 --- a/.gitignore +++ b/.gitignore @@ -15,6 +15,7 @@ node_modules/ .tmp/ .benchmark/ out/ +build/ # Other files package-lock.json diff --git a/LICENSE b/LICENSE index 65a99946..c02c824f 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,9 @@ -The MIT License (MIT) +MIT License Copyright (c) Denis Malinochkin -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/package.json b/package.json index 8f59a60d..80a7d10e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "fast-glob", - "version": "3.3.1", + "version": "4.0.0", "description": "It's a very fast and efficient glob library for Node.js", "license": "MIT", "repository": "mrmlnc/fast-glob", @@ -11,13 +11,13 @@ "engines": { "node": ">=16.14.0" }, - "main": "out/index.js", - "typings": "out/index.d.ts", + "main": "build/index.js", + "typings": "build/index.d.ts", "files": [ - "out", - "!out/{benchmark,tests}", - "!out/**/*.map", - "!out/**/*.spec.*" + "build", + "!build/{benchmark,tests}", + "!build/**/*.map", + "!build/**/*.spec.*" ], "keywords": [ "glob", @@ -35,6 +35,7 @@ "@types/picomatch": "^2.3.0", "@types/sinon": "^10.0.15", "bencho": "^0.1.1", + "esbuild": "^0.19.5", "eslint": "^8.46.0", "eslint-config-mrmlnc": "^4.0.1", "execa": "^7.2.0", @@ -56,7 +57,7 @@ "micromatch": "^4.0.5" }, "scripts": { - "clean": "rimraf out", + "clean": "rimraf out build", "lint": "eslint \"src/**/*.ts\" --cache", "compile": "tsc", "test": "mocha \"out/**/*.spec.js\" -s 0", @@ -64,8 +65,15 @@ "test:e2e:sync": "mocha \"out/**/*.e2e.js\" -s 0 --grep \"\\(sync\\)\"", "test:e2e:async": "mocha \"out/**/*.e2e.js\" -s 0 --grep \"\\(async\\)\"", "test:e2e:stream": "mocha \"out/**/*.e2e.js\" -s 0 --grep \"\\(stream\\)\"", - "build": "npm run clean && npm run compile && npm run lint && npm test", - "watch": "npm run clean && npm run compile -- --sourceMap --watch", + "_build:compile": "npm run clean && npm run compile", + "build": "npm run _build:compile && npm run lint && npm test", + "watch": "npm run _build:compile -- --sourceMap --watch", + "_bundle:dts": "tsc --emitDeclarationOnly --outDir ./build", + "_bundle:ts": "esbuild --bundle ./src/index.ts --outfile=./build/index.js --platform=node --target=node16.14 --format=cjs", + "_bundle:build": "npm run _bundle:dts && npm run _bundle:ts", + "_bundle:test:replace": "cp ./build/index.js ./out", + "_bundle:test": "npm run _bundle:test:replace", + "bundle": "npm run _build:compile && npm run _bundle:build && npm run _bundle:test", "bench:async": "npm run bench:product:async && npm run bench:regression:async", "bench:stream": "npm run bench:product:stream && npm run bench:regression:stream", "bench:sync": "npm run bench:product:sync && npm run bench:regression:sync", @@ -76,6 +84,7 @@ "bench:regression": "npm run bench:regression:async && npm run bench:regression:sync && npm run bench:regression:stream", "bench:regression:async": "hereby bench:regression:async", "bench:regression:sync": "hereby bench:regression:sync", - "bench:regression:stream": "hereby bench:regression:stream" + "bench:regression:stream": "hereby bench:regression:stream", + "prepublishOnly": "npm run bundle" } } diff --git a/src/utils/pattern.ts b/src/utils/pattern.ts index 9d789e79..00c69c40 100644 --- a/src/utils/pattern.ts +++ b/src/utils/pattern.ts @@ -1,6 +1,8 @@ import * as path from 'node:path'; -import * as globParent from 'glob-parent'; +// https://stackoverflow.com/a/39415662 +// eslint-disable-next-line @typescript-eslint/no-require-imports +import globParent = require('glob-parent'); import * as micromatch from 'micromatch'; import type { MicromatchOptions, Pattern, PatternRe } from '../types'; diff --git a/src/utils/stream.ts b/src/utils/stream.ts index cb05ef53..0bf3d3d6 100644 --- a/src/utils/stream.ts +++ b/src/utils/stream.ts @@ -1,4 +1,6 @@ -import * as merge2 from 'merge2'; +// https://stackoverflow.com/a/39415662 +// eslint-disable-next-line @typescript-eslint/no-require-imports +import merge2 = require('merge2'); import type { Readable } from 'node:stream';