Repository: krisk/Fuse Branch: main Commit: fac16735655b Files: 134 Total size: 515.7 KB Directory structure: gitextract_6opxqfu6/ ├── .eslintrc.cjs ├── .github/ │ ├── FUNDING.yml │ ├── ISSUE_TEMPLATE/ │ │ ├── bug_report.yml │ │ ├── config.yml │ │ ├── docs_bug.yml │ │ ├── feature_request.yml │ │ └── support_request.yml │ └── workflows/ │ ├── nodejs.yml │ └── stale.yml ├── .gitignore ├── .husky/ │ ├── commit-msg │ └── pre-commit ├── .npmrc ├── .prettierignore ├── .prettierrc.cjs ├── CHANGELOG.md ├── CONTRIBUTING.md ├── DEVELOPERS.md ├── LICENSE ├── README.md ├── babel.config.json ├── backers.md ├── dist/ │ ├── fuse.basic.cjs │ ├── fuse.basic.min.cjs │ ├── fuse.basic.min.mjs │ ├── fuse.basic.mjs │ ├── fuse.cjs │ ├── fuse.min.cjs │ ├── fuse.min.mjs │ └── fuse.mjs ├── docs/ │ ├── .vuepress/ │ │ ├── client.ts │ │ ├── components/ │ │ │ ├── Demo/ │ │ │ │ ├── Demo.vue │ │ │ │ ├── MonacoEditor.vue │ │ │ │ └── books.ts │ │ │ ├── Donate/ │ │ │ │ └── Donate.vue │ │ │ ├── Jobs/ │ │ │ │ ├── Jobs.vue │ │ │ │ └── jobs.ts │ │ │ ├── Sponsors/ │ │ │ │ └── Sponsors.vue │ │ │ ├── Stories/ │ │ │ │ └── Stories.vue │ │ │ ├── SuspensefulDemo/ │ │ │ │ └── SuspensefulDemo.vue │ │ │ ├── Team/ │ │ │ │ └── Team.vue │ │ │ ├── TwitterFollow/ │ │ │ │ ├── TwitterBird.vue │ │ │ │ └── TwitterFollow.vue │ │ │ └── Version/ │ │ │ ├── Version.vue │ │ │ └── module-declaration.d.ts │ │ ├── config.ts │ │ ├── layouts/ │ │ │ ├── Layout.vue │ │ │ └── components/ │ │ │ ├── AdUnit.vue │ │ │ ├── BuySellAds.vue │ │ │ └── CarbonAds.vue │ │ ├── public/ │ │ │ ├── icons/ │ │ │ │ └── browserconfig.xml │ │ │ └── manifest.webmanifest │ │ ├── styles/ │ │ │ ├── grid.css │ │ │ └── index.scss │ │ └── tsconfig.json │ ├── README.md │ ├── api/ │ │ ├── README.md │ │ ├── config.md │ │ ├── indexing.md │ │ ├── methods.md │ │ ├── options.md │ │ └── query.md │ ├── concepts/ │ │ └── scoring-theory.md │ ├── demo.md │ ├── donate.md │ ├── examples.md │ ├── getting-started/ │ │ ├── different-builds.md │ │ └── installation.md │ ├── jobs.md │ ├── stories.md │ ├── team.md │ └── test.md ├── package.json ├── scripts/ │ ├── build.main.cjs │ ├── bump-docs.cjs │ ├── config-types.cjs │ ├── configs.cjs │ ├── deploy-docs.sh │ └── release.sh ├── src/ │ ├── core/ │ │ ├── computeScore.js │ │ ├── config.js │ │ ├── errorMessages.js │ │ ├── format.js │ │ ├── index.js │ │ ├── queryParser.js │ │ └── register.js │ ├── entry.js │ ├── helpers/ │ │ ├── diacritics.js │ │ ├── get.js │ │ └── types.js │ ├── index.d.ts │ ├── search/ │ │ ├── bitap/ │ │ │ ├── computeScore.js │ │ │ ├── constants.js │ │ │ ├── convertMaskToIndices.js │ │ │ ├── createPatternAlphabet.js │ │ │ ├── index.js │ │ │ └── search.js │ │ ├── extended/ │ │ │ ├── BaseMatch.js │ │ │ ├── ExactMatch.js │ │ │ ├── FuzzyMatch.js │ │ │ ├── IncludeMatch.js │ │ │ ├── InverseExactMatch.js │ │ │ ├── InversePrefixExactMatch.js │ │ │ ├── InverseSuffixExactMatch.js │ │ │ ├── PrefixExactMatch.js │ │ │ ├── SuffixExactMatch.js │ │ │ ├── index.js │ │ │ └── parseQuery.js │ │ └── index.js │ ├── tools/ │ │ ├── FuseIndex.js │ │ ├── KeyStore.js │ │ └── norm.js │ ├── transform/ │ │ ├── index.js │ │ ├── transformMatches.js │ │ └── transformScore.js │ └── tsconfig.json ├── test/ │ ├── __snapshots__/ │ │ ├── extended-search.test.js.snap │ │ ├── fuzzy-search.test.js.snap │ │ └── logical-search.test.js.snap │ ├── extended-search.test.js │ ├── feature-flags.test.js │ ├── fixtures/ │ │ ├── books.json │ │ ├── pokedex.js │ │ ├── pokedex.ts │ │ ├── types.js │ │ └── types.ts │ ├── fuzzy-search.test.js │ ├── indexing.test.js │ ├── logical-search.test.js │ ├── scoring.test.js │ ├── tsconfig.json │ └── typings.test.ts ├── tsconfig.base.json └── vitest.config.ts ================================================ FILE CONTENTS ================================================ ================================================ FILE: .eslintrc.cjs ================================================ module.exports = { root: true, parser: '@babel/eslint-parser', parserOptions: { ecmaVersion: 8, ecmaFeatures: { experimentalObjectRestSpread: true }, sourceType: 'module' }, env: { es6: true, node: true, browser: true, jest: true }, extends: ['eslint:recommended', 'prettier'], rules: { 'no-console': process.env.NODE_ENV !== 'production' ? 0 : 2, 'no-useless-escape': 0, 'no-empty': 0 } } ================================================ FILE: .github/FUNDING.yml ================================================ github: krisk patreon: krisk custom: 'https://www.paypal.com/paypalme2/kirorisk' ================================================ FILE: .github/ISSUE_TEMPLATE/bug_report.yml ================================================ name: Bug Report description: Report a bug in Fuse.js. labels: ['bug'] body: - type: markdown attributes: value: | Thanks for taking the time to fill out this bug report! - type: checkboxes id: new-bug attributes: label: Is there an existing issue for this? description: Please search to see if an issue already exists for the bug you encountered. options: - label: I have searched the existing issues required: true - type: textarea id: bug-description attributes: label: Description of the bug description: Tell us what bug you encountered and what should have happened validations: required: true - type: dropdown id: fuse-version attributes: label: The Fuse.js version where this bug is happening. options: - '6.6.2' - '6.6.1' - '6.6.0' - '6.5.3' - '6.5.2' - '6.5.1' - '6.4.6' - '6.4.5' - '6.4.4' - '6.4.3' - '6.4.2' - '6.4.1' - '6.4.0' - '6.3.1' - '6.3.0' - '6.2.1' - '6.2.0' - '6.0.0' - '5.2.1' - '2.2.0' - '2.0.0' - '1.2.0' - '1.1.0' - '1.0.0' - '1.0.1' - 'Other (please specify in description)' validations: required: true - type: checkboxes id: regression-bug attributes: label: Is this a regression? description: Did this behavior use to work in the previous version? options: - label: This is a regression bug required: false - type: dropdown id: regression-version attributes: label: Which version did this behavior use to work in? description: In case you checked the regression bug checkbox, please provide the version in which this bug was not present. options: - '6.6.2' - '6.6.1' - '6.6.0' - '6.5.3' - '6.5.2' - '6.5.1' - '6.4.6' - '6.4.5' - '6.4.4' - '6.4.3' - '6.4.2' - '6.4.1' - '6.4.0' - '6.3.1' - '6.3.0' - '6.2.1' - '6.2.0' - '6.0.0' - '5.2.1' - '2.2.0' - '2.0.0' - '1.2.0' - '1.1.0' - '1.0.0' - '1.0.1' - 'Other (please specify in description)' - type: textarea id: steps-to-reproduce attributes: label: Steps To Reproduce description: Steps to reproduce the behavior. placeholder: | Please tell us how to reproduce this bug, for example: 1. Write '...' 2. Click on '...' 3. See error validations: required: true - type: textarea id: expected-behavior attributes: label: Expected behavior description: What should be the expected behavior. placeholder: A clear and concise description of what you expected to happen. validations: required: true - type: textarea id: screenshots attributes: label: Screenshots description: If applicable, add screenshots to help explain your problem. placeholder: Paste your screenshots here. - type: textarea id: additional-context attributes: label: Additional context description: Do you want to share any additional context about this bug? placeholder: Add any other context about the problem here. - type: markdown attributes: value: | Love Fuse.js? Please consider supporting: 👉 https://github.com/sponsors/krisk 👉 https://www.patreon.com/krisk 👉 https://www.paypal.com/paypalme2/kirorisk ================================================ FILE: .github/ISSUE_TEMPLATE/config.yml ================================================ blank_issues_enabled: false ================================================ FILE: .github/ISSUE_TEMPLATE/docs_bug.yml ================================================ name: Docs on fusejs.io description: Report an issue in Fuse.js documentation or fusejs.io labels: ['docs'] body: - type: markdown attributes: value: | Thanks for taking the time to fill out this bug report! - type: checkboxes id: new-bug attributes: label: Is there an existing issue for this? description: Please search to see if an issue already exists for the bug you encountered. options: - label: I have searched the existing issues required: true - type: textarea id: bug-description attributes: label: Description of the bug description: Tell us what bug you encountered and what should have happened validations: required: true - type: textarea id: screenshots attributes: label: Screenshots description: If applicable, add screenshots to help explain your problem. placeholder: Paste your screenshots here. - type: markdown attributes: value: | Love Fuse.js? Please consider supporting: 👉 https://github.com/sponsors/krisk 👉 https://www.patreon.com/krisk 👉 https://www.paypal.com/paypalme2/kirorisk ================================================ FILE: .github/ISSUE_TEMPLATE/feature_request.yml ================================================ name: Feature request description: Suggest a feature for Fuse.js. labels: ['feature'] body: - type: markdown attributes: value: Thank you for suggesting this feature! The more information you provide, the more likely it is that it will be picked up. - type: checkboxes id: new-feature attributes: label: Is there an existing issue or pull request for this? description: Please search to see if an issue or pull request already exists for the feature you desire. options: - label: I have searched the existing issues and pull requests required: true - type: textarea id: feature-description attributes: label: Feature description description: Is your feature request related to a problem? Please describe. placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] validations: required: true - type: textarea id: desired-solution attributes: label: Desired solution description: Describe the solution you'd like placeholder: A clear and concise description of what you want to happen. validations: required: true - type: textarea id: alternatives-considered attributes: label: Alternatives considered description: Describe alternatives you've considered placeholder: A clear and concise description of any alternative solutions or features you've considered. validations: required: true - type: textarea id: additional-context attributes: label: Additional context description: Do you want to share any additional context about this bug? placeholder: Add any other context about the problem here. - type: markdown attributes: value: | Love Fuse.js? Please consider supporting: 👉 https://github.com/sponsors/krisk 👉 https://www.patreon.com/krisk 👉 https://www.paypal.com/paypalme2/kirorisk ================================================ FILE: .github/ISSUE_TEMPLATE/support_request.yml ================================================ name: Support request description: Questions and requests for support. labels: ['question'] body: - type: checkboxes id: new-question attributes: label: Is there an existing issue for this? description: Please search to see if an issue already exists for the question you want answered. options: - label: I have searched the existing issues required: true - type: textarea id: question-description attributes: label: Your question validations: required: true - type: markdown attributes: value: | Love Fuse.js? Please consider supporting: 👉 https://github.com/sponsors/krisk 👉 https://www.patreon.com/krisk 👉 https://www.paypal.com/paypalme2/kirorisk ================================================ FILE: .github/workflows/nodejs.yml ================================================ # This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions name: Node.js CI on: push: branches: - master pull_request: branches: - master concurrency: group: ${{ github.workflow }}-${{ github.head_ref || github.ref }} cancel-in-progress: true jobs: build: runs-on: ubuntu-latest strategy: matrix: node: [14, 15, 16, 17, 18, 19] steps: - name: Checkout Project uses: actions/checkout@v3 - name: Use Node.js v${{ matrix.node }} uses: actions/setup-node@v3 with: node-version: ${{ matrix.node }} - name: Install Dependencies run: npm ci - name: Build Code run: npm run build - name: Test Code run: npm run test ================================================ FILE: .github/workflows/stale.yml ================================================ name: Mark stale issues on: schedule: - cron: '0 0 * * *' jobs: stale: runs-on: ubuntu-latest steps: - uses: actions/stale@v7 with: stale-issue-message: 'This issue is stale because it has been open 120 days with no activity. Remove stale label or comment or this will be closed in 30 days' days-before-stale: 120 days-before-close: 30 ================================================ FILE: .gitignore ================================================ node_modules/ *.log .DS_Store .idea/ .vs/ .vscode/ # Ignore yarn lock files yarn.lock dist/*.d.ts dist/*.js dist/*.map docs/.vuepress/dist RELEASE_NOTE*.md playground/ Makefile # Vuepress files .temp .cache ================================================ FILE: .husky/commit-msg ================================================ #!/usr/bin/env sh . "$(dirname -- "$0")/_/husky.sh" npx --no -- commitlint --edit "$1" ================================================ FILE: .husky/pre-commit ================================================ #!/bin/sh . "$(dirname "$0")/_/husky.sh" npm test ================================================ FILE: .npmrc ================================================ legacy-peer-deps=true ================================================ FILE: .prettierignore ================================================ dist/ CHANGELOG.md docs/.vuepress/.temp/ docs/.vuepress/.cache/ ================================================ FILE: .prettierrc.cjs ================================================ module.exports = { trailingComma: 'none', tabWidth: 2, semi: false, singleQuote: true, overrides: [ { files: '*.svg', options: { parser: 'html' } } ] } ================================================ FILE: CHANGELOG.md ================================================ # Changelog All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. ## [7.1.0](https://github.com/krisk/Fuse/compare/v7.0.0...v7.1.0) (2025-02-03) ### Features * add ignore diacritics ([e0fcdb1](https://github.com/krisk/Fuse/commit/e0fcdb15d491e7db28c4902727d2d859833ea9ee)) * add option to ignore diacritics ([fb012b7](https://github.com/krisk/Fuse/commit/fb012b7388442f7dcc0facb43f0b2840057ca8c5)) ### Bug Fixes * remove console.log ([1c749a3](https://github.com/krisk/Fuse/commit/1c749a3f43d37d89233fdac9014009b3dac9e53d)) * **typescript:** clarify input to `parseIndex` ([72b6e25](https://github.com/krisk/Fuse/commit/72b6e25e14663cdbea9dee297b60963c7d6a8983)), closes [#524](https://github.com/krisk/Fuse/issues/524) [#624](https://github.com/krisk/Fuse/issues/624) * **typescript:** clarify input to `parseIndex` ([78c628e](https://github.com/krisk/Fuse/commit/78c628e50f6b3b7d185eaa27ded60002ba9d15ef)), closes [#524](https://github.com/krisk/Fuse/issues/524) [#624](https://github.com/krisk/Fuse/issues/624) ## [7.0.0](https://github.com/krisk/Fuse/compare/v6.6.2...v7.0.0) (2023-10-24) ### ⚠ BREAKING CHANGES * Extension changed ### Features * finish all but state handling of live demo ([9b5421a](https://github.com/krisk/Fuse/commit/9b5421a7febd1f57cbd504855ea375eec5d57843)) * implementing reacting to option changes ([46c561c](https://github.com/krisk/Fuse/commit/46c561c05c97abd05f7ab7de7e78b03ede8d07da)) * improve fuse keys ([c47f3d4](https://github.com/krisk/Fuse/commit/c47f3d49f9b0262164368b765e2cf8d053556359)) * proper ESM exports ([eebcf2c](https://github.com/krisk/Fuse/commit/eebcf2c77b4c9869fab4bdbd93f3a15198514333)) * properly configure monaco editors ([fe0d33e](https://github.com/krisk/Fuse/commit/fe0d33e3025857c3db9ada7f66d834a6fc36f076)) ### Bug Fixes * add favicon on public root ([bc155a3](https://github.com/krisk/Fuse/commit/bc155a31440438d29904aadfe9075225ceddc689)) * add proper ESM exports in package.json ([98366b1](https://github.com/krisk/Fuse/commit/98366b1630c83e1c64eaae5cccf8f39403b7fc4d)) * build fixes ([5969ca7](https://github.com/krisk/Fuse/commit/5969ca716a52aa24fafa476bee02140518202593)) * double totalWeight ([5c0ab46](https://github.com/krisk/Fuse/commit/5c0ab467242d1de5d62bd3cdb812518e4b037c0f)) * fixed browserconfig xml file ([ca0cbbb](https://github.com/krisk/Fuse/commit/ca0cbbbc2fa64d7e0511c86cced2d09d3ec8efcb)) * fixed config, packages, and twitter social button ([bd7555c](https://github.com/krisk/Fuse/commit/bd7555cd0b8b990ca38faf8196a92207785e95a3)) * fixed navbar ([29b2599](https://github.com/krisk/Fuse/commit/29b25990d592a797df51a3dc15c678defce56538)) * fixed version display and active search plugin ([6e2a592](https://github.com/krisk/Fuse/commit/6e2a5922270a22bc9f1b827efd311608a2ea1839)) * imports ([ec4e3bc](https://github.com/krisk/Fuse/commit/ec4e3bc1ee6ba4655642e5740cabb864bcb70275)) * re-implement sidebar advertisements ([67a10cf](https://github.com/krisk/Fuse/commit/67a10cf8d8df22dd198a2e9c3ee5413631459d4a)) * support -> donate for clarity of what it is ([ef99f56](https://github.com/krisk/Fuse/commit/ef99f5633d65e26cd555e847216bf231bcd43823)) * vite SSR build fixes ([3ae8299](https://github.com/krisk/Fuse/commit/3ae8299faac02ca33ea9c7773ea34be2217d533c)) ### [6.6.2](https://github.com/krisk/Fuse/compare/v6.6.1...v6.6.2) (2022-05-11) ### Bug Fixes * value fetched at the end must be a string ([1de1dff](https://github.com/krisk/Fuse/commit/1de1dffa3f16992e21d817370e2b5d9611d3ad6d)), closes [#661](https://github.com/krisk/Fuse/issues/661) ### [6.6.1](https://github.com/krisk/Fuse/compare/v6.6.0...v6.6.1) (2022-05-06) ### Bug Fixes * getFn to FuseOptionKeyObject ([80b87a9](https://github.com/krisk/Fuse/commit/80b87a9035b3dcecc92dc913ceb160045e1a95bd)), closes [#655](https://github.com/krisk/Fuse/issues/655) * **typescript:** type definition for `FuseOptionKeyObject, fixes [#655](https://github.com/krisk/Fuse/issues/655) ([4acabb6](https://github.com/krisk/Fuse/commit/4acabb686f9a1a95adc766bc2fb387c0ce0b477c)) * **typescript:** type definition for FuseOptionKeyObject ([0a790b5](https://github.com/krisk/Fuse/commit/0a790b516efec2e6c5539bdd40d04889e6252dfe)), closes [#655](https://github.com/krisk/Fuse/issues/655) [#656](https://github.com/krisk/Fuse/issues/656) ## [6.6.0](https://github.com/krisk/Fuse/compare/v6.5.3...v6.6.0) (2022-05-03) ### Features * allow passing getFn for a specific key ([1d445b9](https://github.com/krisk/Fuse/commit/1d445b9999e26d6eefecbdd333d46be01aff06e5)), closes [#627](https://github.com/krisk/Fuse/issues/627) ### Bug Fixes * excessive splitting in parseQuery ([2c78022](https://github.com/krisk/Fuse/commit/2c78022c6ccb424e1013dc486649a7d6388df193)) * type mismatch on toJSON ([f5425ea](https://github.com/krisk/Fuse/commit/f5425ea1bd6b95eae912b8dab68c9e3cac0ad27f)) ### [6.5.3](https://github.com/krisk/Fuse/compare/v6.5.2...v6.5.3) (2021-12-23) ### Bug Fixes * **logical:** scoring for logical OR ([6f6af51](https://github.com/krisk/Fuse/commit/6f6af51cc39058fafea6b126f7120afc4f7c192a)), closes [#593](https://github.com/krisk/Fuse/issues/593) ### [6.5.2](https://github.com/krisk/Fuse/compare/v6.5.1...v6.5.2) (2021-12-23) ### [6.5.1](https://github.com/krisk/Fuse/compare/v6.5.0...v6.5.1) (2021-12-23) ### Bug Fixes * rollback min node version ([9918f67](https://github.com/krisk/Fuse/commit/9918f67ba9b6b9b54e53576312fa33a51f428a9d)) ## [6.5.0](https://github.com/krisk/Fuse/compare/v6.4.6...v6.5.0) (2021-12-22) ### Features * **scoring:** field length norm weight ([a9e0080](https://github.com/krisk/Fuse/commit/a9e00804497a1bfd7a94040520417825c085c945)) ### Bug Fixes * **typescript:** add config declaration to types ([2f4de0c](https://github.com/krisk/Fuse/commit/2f4de0c5ce061808f460de7f399b56a06539d4d5)) ### [6.4.6](https://github.com/krisk/Fuse/compare/v6.4.5...v6.4.6) (2021-01-05) ### Bug Fixes * **typescript:** fix search typings ([94766b2](https://github.com/krisk/Fuse/commit/94766b2ffcc2be0e5f15daa9a29cd92adbe2647a)), closes [#527](https://github.com/krisk/Fuse/issues/527) ### [6.4.5](https://github.com/krisk/Fuse/compare/v6.4.4...v6.4.5) (2021-01-01) ### Bug Fixes * **ts:** export FuseIndex type ([2e60bee](https://github.com/krisk/Fuse/commit/2e60bee242c7b82f0d014a3a35281b34bc6b62fb)), closes [#519](https://github.com/krisk/Fuse/issues/519) ### [6.4.4](https://github.com/krisk/Fuse/compare/v6.4.3...v6.4.4) (2020-12-29) ### Bug Fixes * **extended:** correctly score include-match results ([443c863](https://github.com/krisk/Fuse/commit/443c863c44a48225510057d7597cb743fda2d25f)), closes [#522](https://github.com/krisk/Fuse/issues/522) ### [6.4.3](https://github.com/krisk/Fuse/compare/v6.4.2...v6.4.3) (2020-10-30) ### Bug Fixes * **extended:** ignoreLocation when useExtendedSearch is true ([8f67ac9](https://github.com/krisk/Fuse/commit/8f67ac985d3440c20d93ce1e1c5ba66f384ea9bf)), closes [#465](https://github.com/krisk/Fuse/issues/465) ### [6.4.2](https://github.com/krisk/Fuse/compare/v6.4.1...v6.4.2) (2020-10-20) ### Bug Fixes * if null in array ([740a500](https://github.com/krisk/Fuse/commit/740a5004763d84b285075a2cece4f37bc5fa2830)) ### [6.4.1](https://github.com/krisk/Fuse/compare/v6.4.0...v6.4.1) (2020-07-26) ### Bug Fixes * handle booleans in the data ([226d868](https://github.com/krisk/Fuse/commit/226d868a1102402e1e773db305ddd3928ae92f79)), closes [#469](https://github.com/krisk/Fuse/issues/469) ## [6.4.0](https://github.com/krisk/Fuse/compare/v6.3.1...v6.4.0) (2020-06-28) ### Features * **extended:** add ability to search actual exact string ([350283f](https://github.com/krisk/Fuse/commit/350283f45a9affe05c6b3176bb5a5a037916de58)) ### [6.3.1](https://github.com/krisk/Fuse/compare/v6.3.0...v6.3.1) (2020-06-24) ### Bug Fixes * **logical:** scores in logical query operators are ignored ([e357229](https://github.com/krisk/Fuse/commit/e357229846fff585707903c93f556d1562fbabba)), closes [#449](https://github.com/krisk/Fuse/issues/449) ## [6.3.0](https://github.com/krisk/Fuse/compare/v6.2.1...v6.3.0) (2020-06-23) ### Features * provide alternative array notation for nested paths ([7077fbe](https://github.com/krisk/Fuse/commit/7077fbe5f40872f9555645dbad2e6729ca55a5d4)), closes [#432](https://github.com/krisk/Fuse/issues/432) ### Bug Fixes * **typescript:** add types for string and object together for the key property ([85fb211](https://github.com/krisk/Fuse/commit/85fb211a22bf5921ecefab9ecf3f8e2647f46b49)) * **typescript:** add typing for nested paths with array notation ([dfa4823](https://github.com/krisk/Fuse/commit/dfa48238f9a28600fd36677f958f43bb3cab4c03)) # Version 6.0.0 - Added [logical query expressions](https://fusejs.io/api/query.html) (#411) - Added ability to dynamically add/remove items (#412) - Mix different `options:key` types during initialization (#413) - Improved indexing performances, as well storage savings (#405, #407) # Version 5.2.0 - Addresses #390, #376, #382, #385 - Removed ngram search and extended bitap to search long patterns # Version 5.0.9-beta - Fixed Fuse global name. Erroneously set as 'Fuse.js' # Version 5.0.8-beta - Changed bundler to Rollup. - Added ES6 modules for bundlers and browsers (`fuse.esm.js`) (fixed [#262](#262)) - Added CommonJS builds (`fuse.common.js`) ## Breaking Changes - The minimified version is finally actually called `fuse.min.js` # Version 5.0.7-beta - Fixed (#363) # Version 5.0.6-beta - Fixed (#357) # Version 5.0.3-beta - A couple of fixes, courtesy of [Daniel Dickinson](https://github.com/cshoredaniel): - Generate multiple targets with webpack (#359) - Fixed TypeError (#360) # Version 5.0.2-beta - Added indexing for increased performance over large lists - Added `Fuse.createIndex`, which created and returns an index. This function can be used to pre-generate the index, which you can then save, and ultimately pass to the `Fuse` instance. ## Breaking Changes - Removed `id` option - Changed format of the search results - Updated TypeScript definitions # Version 5.0.1-beta - Removed `matchAllTokens` option. # Version 5.0.0-beta - Added ability to search patterns longer > 32 characters - Removed `maxPatternLength` option # Version 4.1.0-beta - Perf optimization on nested array search # Version 4.0.4-beta - Re-added license information # Version 4.0.3-beta - Increased Node version # Version 4.0.2-beta - Added missing tests # Version 4.0.1-beta - Removed unused codepath - Fixed case sensitivity check - Upgraded dev dependencies # Version 4.0.0-beta - Added extended search [Discussion](https://github.com/krisk/Fuse/issues/356) - Removed tokenization [Discussion](https://github.com/krisk/Fuse/issues/355) # Version 3.6.0 - Improved error handling for keys # Version 3.5.0 - Fixed #341, adjusting weights into the calculation - Improved performance by ~10% (really can only be seen when you have 10k+ items) # Version 3.4.3 - Fixed #261 - Rewrote tests to Jest framework - Wrote tests for TypeScript typings - Cleanup build # Version 3.4.2 - Fixed #288 # Version 3.4.1 - Ensured `dist/` content is production ready (both full and min versions) #283 # Version 3.4.0 - Upgraded build tool to Webpack 4. New `dist/` output. # Version 3.3.1 - Fixed the circular JSON TypeError (#197). Thanks [ThinkTankShark](https://github.com/ThinkTankShark)! # Version 3.2.1 - Fixed issue in which more fuzzy matches would weaken a score instead of strengthening it (#233) # Version 3.2.0 - Give better result for exact match when using weighted keys (#192) # Version 3.1.0 - Added match index location for array key (#183) - Allow searching deep nested numbers (#189) # Version 3.0.5 - Escape special characters in search pattern (#168) # Version 3.0.4 - Random bug fixes (#162) # Version 3.0.0 - Removed Bower support - Modified library into a more more palatable architecture, where the Bitap portion is now its own separate module. ### BREAKING CHANGES - Removed `include` option in favor of more explicit booleans: `includeScore` and `includeMatches`. Both are `false` by default. - Removed `searchFn` option, as this (for now) will remain a Bitap based solution # Version 2.7.4 - Reverted to previous version, thus fixing breaking changes (a little bit of a version match here) # Version 2.6.2 - Revert back to previous version # Version 2.6.2 - Fix typings based on TypeScript guidelines (#129) # Version 2.6.0 - Added Typescript definition - Added ability to set min/max matched character lengths when returning the matched indices (#122) # Version 2.5.0 - Added option to search by matching all tokens (in every record) when `matchAllTokens:true` (#95) # Version 2.3.0 - Added token separator to options, when `tokenize:true` (#93) - General code clean up (#88) - Bunch of other bug fixes # Version 2.2.0 - Added option to include matched indices (#6) - Added ability to search with weighted keys (#62) # Version 2.1.0-beta - Added ability to search with weighted keys (#62) # Version 2.0.0 - Modified search algorithm to search individual words AND the full string, computing the final score as a function of both. This yields better scoring accuracy (#41) - Changed exact substrings to not have a score of zero. That is searching for "hell" in "hello" will not yield a score of zero, while searching for "hello" will (#63) - Added `verbose` option, which will print to the console useful information, mostly for debugging - Improved code structure. - Added version information within Fuse itself - Added this Changelog (#64) - Added fallback when pattern length is greater than machine word length (i.e, > 32 characters) (#38) - Allowed results with a value of 0 to be returned (#73) ================================================ FILE: CONTRIBUTING.md ================================================ # Contributing to Fuse.js We'd love for you to contribute to our source code and to make Fuse.js better! Here are the guidelines we'd like you to follow: - [Questions and Problems](#question) - [Issues and Bugs](#issue) - [Pull Request Submission Guidelines](#submit-pr) ## Questions, Bugs, Features ### Got a Question or Problem? Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on dedicated support platforms, the best being [Stack Overflow][stackoverflow]. ### Found an Issue or Bug? If you find a bug in the source code, you can help us by submitting an issue to our [GitHub Repository][github]. Even better, you can submit a Pull Request with a fix. When creating issues, it's important to follow common guidelines to make them extra clear. Here is a few links to help you achieve that: - [GitHub Guides: Mastering Issues](https://guides.github.com/features/issues/) - [Wiredcraft: How We Write Github Issues](https://wiredcraft.com/blog/how-we-write-our-github-issues/) - [NYC Planning Digital: Writing a proper GitHub issue](https://medium.com/nyc-planning-digital/writing-a-proper-github-issue-97427d62a20f) ## Pull Request Submission Guidelines Before you submit your pull request consider the following guidelines: - Search [GitHub](https://github.com/krisk/Fuse/pulls) for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort. - Make your changes in a new git branch: ```shell git checkout -b my-fix-branch main ``` - Create your patch commit, **including appropriate test cases**. - Run `npm run lint` to check that you have followed the automatically enforced coding rules - Commit your changes using a descriptive commit message that follows our [commit message conventions][developers.commits]. Adherence to the [commit message conventions][developers.commits] is required, because release notes are automatically generated from these messages. ```shell git commit -a ``` - Before creating the Pull Request, package and run all tests a last time: ```shell npm run test ``` - Push your branch to GitHub: ```shell git push origin my-fix-branch ``` - If we suggest changes, then: - Make the required updates. - Re-run the test suite to ensure tests are still passing. - Commit your changes to your branch (e.g. `my-fix-branch`). - Push the changes to your GitHub repository (this will update your Pull Request). You can also amend the initial commits and force push them to the branch. ```shell git rebase main -i git push origin my-fix-branch -f ``` This is generally easier to follow, but separate commits are useful if the Pull Request contains iterations that might be interesting to see side-by-side. That's it! Thank you for your contribution! ### After your pull request is merged After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository: - Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows: ```shell git push origin --delete my-fix-branch ``` - Check out the main branch: ```shell git checkout main -f ``` - Delete the local branch: ```shell git branch -D my-fix-branch ``` - Update your main with the latest upstream version: ```shell git pull --ff upstream main ``` [stackoverflow]: http://stackoverflow.com/questions/tagged/fuse.js [github]: https://github.com/krisk/Fuse/issues [developers.commits]: DEVELOPERS.md#commits ================================================ FILE: DEVELOPERS.md ================================================ # Developing Fuse.js - [Running Tests](#tests) - [Commit Message Guidelines](#commits) ## Running Tests ```shell npm run test ``` ## Git Commit Guidelines Fuse.js follows [conventional commits](conventional-commits). This leads to **more readable messages** that are easy to follow when looking through the **project history**. Also, these git commit messages are used to **generate the [changelog](changelog)**. ### Commit Message Format Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**: ``` ():