Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codeque-co/codeque
Find and lint complex code patterns effortlessly
https://github.com/codeque-co/codeque
Last synced: 2 months ago
JSON representation
Find and lint complex code patterns effortlessly
- Host: GitHub
- URL: https://github.com/codeque-co/codeque
- Owner: codeque-co
- License: other
- Created: 2022-06-20T18:44:19.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-06-30T10:39:06.000Z (5 months ago)
- Last Synced: 2024-08-19T08:39:51.046Z (3 months ago)
- Language: TypeScript
- Homepage: https://codeque.co
- Size: 17.3 MB
- Stars: 134
- Watchers: 5
- Forks: 6
- Open Issues: 19
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE.md
Awesome Lists containing this project
README
Website •
Docs •
Roadmap •
Mission •
Playground
Find and lint complex code patterns effortlessly
___
# What is CodeQue?
CodeQue is semantic code search engine that understands the code syntax.
It matches code structurally which makes it excellent for more complex queries.
Query language offers wildcards, partial matching and ignores code formatting.
Structural code search is available for JavaScript, TypesScript, HTML, CSS, Python, Lua and more soon.
Text code search with handy wildcards is available for __every language__ and covers common regex search use cases.
Just paste code snippet to start searching, no installation needed!
__Integrations__
CodeQue is available as:
- [VSCode extension](https://marketplace.visualstudio.com/items?itemName=CodeQue.codeque) for delightful code search and navigation experience.
- [ESLint integration](https://www.npmjs.com/package/@codeque/eslint-plugin) for creating custom linting rules in zero time.
- [CLI tool](https://www.npmjs.com/package/@codeque/cli) for searching code and more including headless environments.
All CodeQue tools work offline hence code never leaves your local environment.
__Coming soon__
CodeQue will be soon available as:
- Duplicated code identification
- Batch code refactoring
- Advanced ESLint rule creator
🔔 Get notified about updates 🔔
## Visual Studio Code Extension 🔮
VScode extension aims to make your workflow more efficient.
It addresses the problems of standard search by providing multiline support and offers an easy way to add gaps or use wildcards in the query.
You don't need to have any Regex knowledge to query complex code patterns.
With CodeQue, you can easily navigate and modify your codebase, making your development process faster and more efficient.
It will help you with code refactoring, speed up project discovery, and make it easy to find duplicated or similar code patterns.
Advanced code search options and todo-like list of accurate search results will streamline your workflow.
Watch extension in action in 1 minute (external link) 👇
Get extension from marketplace
## ESLint integration 💅
Using CodeQue ESLint plugin you can create your own custom linting rules in zero time.
Custom ESLint rules can help execute on long-term refactors or prevent introducing codebase specific bugs or bad patterns.
Rules can replace your decision log and help standardizing coding conventions across the project or organization.
CodeQue ESLint integration is a no-brainier for any team willing to improve their codebase quality.
__Installation 👇__
```sh
yarn add --dev @codeque/eslint-plugin
```
__Usage ✨__
Enhance your `.eslintrc` with following setup:
```json
{
"plugins": ["@codeque"],
"rules": {
"@codeque/error": ["error", [
{
"query": "fetchData()",
"mode": "exact",
"message": "Using fetchData() without parameters causes app crash!",
},
]],
"@codeque/warning": ["warn", [
{
"query": "import $$$ from 'lodash';",
"mode": "include",
"message": "Prefer to import lodash functions from separate packages like 'lodash.debounce'",
},
]]
}
}
```
Find more information in [`@codeque/eslint-plugin` package readme](https://www.npmjs.com/package/@codeque/eslint-plugin)
## CLI tool 🔥
CodeQue CLI is a complementary tool that can be used for
- Searching code patterns right from terminal including headless environments
- Building scripts to assert that some code patterns exist or not exist
- Enhancing git hooks to avoid committing or pushing unwanted code
__Installation 👇__
```sh
yarn global add @codeque/cli
```
__Usage ✨__
```sh
codeque
```
Find more information in [`@codeque/cli` package readme](https://www.npmjs.com/package/@codeque/cli)
## Support and feedback
Feel free to use [Github Issues](https://github.com/codeque-co/codeque/issues)
to
- ask for help with writing a query
- report a bug or doubt
- suggest feature or improvement