1414
1515<p align =" center " >Find and lint complex code patterns effortlessly</p >
1616
17- ___
17+ ---
1818
1919# What is CodeQue?
2020
21- CodeQue is semantic code search engine that understands the code syntax.
21+ CodeQue is semantic code search engine that understands the code syntax.
2222
2323It matches code structurally which makes it excellent for more complex queries.
2424
25- Query language offers wildcards, partial matching and ignores code formatting.
25+ Query language offers wildcards, partial matching and ignores code formatting.
2626
27- Structural code search is available for JavaScript, TypesScript, HTML, CSS, Python, Lua and more soon.
27+ Structural code search is available for JavaScript, TypesScript, HTML, CSS, Python, Lua, C# and more soon.
2828
29- Text code search with handy wildcards is available for __ every language __ and covers common regex search use cases.
29+ Text code search with handy wildcards is available for ** every language ** and covers common regex search use cases.
3030
3131<p align =" center " ><a href =" https://codeque.co/playground?utm_source=readme_main " ><b >Give it a try in
3232 playground</b ></a ></p >
3333
3434<p align =" center " ><i >Just paste code snippet to start searching, no installation needed!</i ></p >
3535
36- __ Integrations __
36+ ** Integrations **
3737
3838CodeQue is available as:
3939
@@ -43,33 +43,33 @@ CodeQue is available as:
4343
4444<p align =" center " ><i >All CodeQue tools <b >work offline</b > hence code never leaves your local environment.</i ></p >
4545
46- __ Coming soon __
46+ ** Coming soon **
4747
4848CodeQue will be soon available as:
4949
5050- Duplicated code identification
51- - Batch code refactoring
52- - Advanced ESLint rule creator
53-
51+ - Batch code refactoring
52+ - Advanced ESLint rule creator
5453
5554<p align =" center " ><a href =" https://jayu.dev/newsletter?utm_source=readme_main " ><b >🔔 Get notified about updates 🔔 </b ></a ></p >
5655
57-
5856</br >
5957
6058<!-- HERO END -->
61-
59+
6260<!-- VSCODE INTRO START -->
61+
6362## Visual Studio Code Extension 🔮
63+
6464VScode extension aims to make your workflow more efficient.
6565
66- 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.
66+ 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.
6767
68- You don't need to have any Regex knowledge to query complex code patterns.
68+ You don't need to have any Regex knowledge to query complex code patterns.
6969
7070With CodeQue, you can easily navigate and modify your codebase, making your development process faster and more efficient.
7171
72- It will help you with code refactoring, speed up project discovery, and make it easy to find duplicated or similar code patterns.
72+ It will help you with code refactoring, speed up project discovery, and make it easy to find duplicated or similar code patterns.
7373
7474Advanced code search options and todo-like list of accurate search results will streamline your workflow.
7575
@@ -102,40 +102,45 @@ CodeQue ESLint integration is a no-brainier for any team willing to improve thei
102102
103103<!-- ESLINT INTRO END -->
104104
105- __ Installation 👇 __
105+ ** Installation 👇 **
106106
107107``` sh
108108yarn add --dev @codeque/eslint-plugin
109109```
110110
111-
112- __ Usage ✨__
111+ ** Usage ✨**
113112
114113Enhance your ` .eslintrc ` with following setup:
115114
116115``` json
117116{
118117 "plugins" : [" @codeque" ],
119118 "rules" : {
120- "@codeque/error" : [" error" , [
121- {
122- "query" : " fetchData()" ,
123- "mode" : " exact" ,
124- "message" : " Using fetchData() without parameters causes app crash!" ,
125- },
126- ]],
127- "@codeque/warning" : [" warn" , [
128- {
129- "query" : " import $$$ from 'lodash';" ,
130- "mode" : " include" ,
131- "message" : " Prefer to import lodash functions from separate packages like 'lodash.debounce'" ,
132- },
133- ]]
119+ "@codeque/error" : [
120+ " error" ,
121+ [
122+ {
123+ "query" : " fetchData()" ,
124+ "mode" : " exact" ,
125+ "message" : " Using fetchData() without parameters causes app crash!"
126+ }
127+ ]
128+ ],
129+ "@codeque/warning" : [
130+ " warn" ,
131+ [
132+ {
133+ "query" : " import $$$ from 'lodash';" ,
134+ "mode" : " include" ,
135+ "message" : " Prefer to import lodash functions from separate packages like 'lodash.debounce'"
136+ }
137+ ]
138+ ]
134139 }
135140}
136141```
137- Find more information in [ ` @codeque/eslint-plugin ` package readme] ( https://www.npmjs.com/package/@codeque/eslint-plugin )
138142
143+ Find more information in [ ` @codeque/eslint-plugin ` package readme] ( https://www.npmjs.com/package/@codeque/eslint-plugin )
139144
140145</br >
141146
@@ -149,19 +154,20 @@ Find more information in [`@codeque/eslint-plugin` package readme](https://www.n
149154## CLI tool 🔥
150155
151156CodeQue CLI is a complementary tool that can be used for
157+
152158- Searching code patterns right from terminal including headless environments
153159- Building scripts to assert that some code patterns exist or not exist
154160- Enhancing git hooks to avoid committing or pushing unwanted code
155161
156162<!-- CLI INTRO END -->
157163
158- __ Installation 👇 __
164+ ** Installation 👇 **
159165
160166``` sh
161167yarn global add @codeque/cli
162168```
163169
164- __ Usage ✨ __
170+ ** Usage ✨ **
165171
166172``` sh
167173codeque
@@ -181,6 +187,7 @@ Find more information in [`@codeque/cli` package readme](https://www.npmjs.com/p
181187
182188Feel free to use [ Github Issues] ( https://github.com/codeque-co/codeque/issues )
183189to
190+
184191- ask for help with writing a query
185192- report a bug or doubt
186- - suggest feature or improvement
193+ - suggest feature or improvement
0 commit comments