Skip to content

Commit 96db9b5

Browse files
jayujayu
committed
chore: add script to align readmes
1 parent 9e8d8e5 commit 96db9b5

14 files changed

Lines changed: 258 additions & 73 deletions

File tree

‎.gitignore‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,6 @@ devFile
1010
*.snapshot.json
1111
dist
1212
*.temp
13-
.vscode/settings.json
13+
.vscode/settings.json
14+
*.tgz
15+
*.tar.gz

‎Readme.md‎

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ It matches code structurally which makes it excellent for more complex queries.
2424

2525
Query language offers wildcards, partial matching and ignores code formatting.
2626

27-
Structural search is available for JavaScript, TypesScript, HTML, CSS and more soon.
27+
Structural code search is available for JavaScript, TypesScript, HTML, CSS and more soon.
2828

29-
Text 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"><b>Give it a try in
3232
playground</b></a></p>
@@ -39,23 +39,23 @@ CodeQue is available as:
3939

4040
- [VSCode extension](https://marketplace.visualstudio.com/items?itemName=CodeQue.codeque) for enhanced code search and navigation experience.
4141
- [ESLint integration](https://www.npmjs.com/package/@codeque/eslint-plugin) for creating custom linting rules in zero time.
42-
- [CLI tool](https://www.npmjs.com/package/@codeque/cli) for searching code and more, also in headless environments.
42+
- [CLI tool](https://www.npmjs.com/package/@codeque/cli) for searching code and more including headless environments.
4343

4444
CodeQue will be soon available as:
4545

4646
- Duplicated code identification
4747
- Batch code refactoring
48-
- Advanced ESLint rules generator
48+
- Advanced ESLint rules creator
4949

50-
</br>
5150

52-
<p align="center"><a href="https://codeque.co/playground"> 🔔 Get notified 🔔 </a></p>
51+
<p align="center"><a href="https://jayu.dev/newsletter"><b>🔔 Get notified 🔔 </b></a></p>
52+
53+
<p align="center"><i>All CodeQue tools <b>operate offline</b> hence code never leaves your local environment.</i></p>
5354

5455
</br>
5556

5657
<!-- HERO END -->
5758

58-
5959
## Visual Studio Code Extension 🔮
6060

6161
VScode extension aims to make your workflow more efficient.
@@ -72,10 +72,20 @@ VScode extension aims to make your workflow more efficient.
7272
<img src="https://github.com/codeque-co/codeque/blob/master/packages/vscode/readme-media/intro.gif?raw=true" />
7373
</a>
7474

75+
</br>
76+
77+
<!-- ESLINT INTRO START -->
7578
## ESLint integration 💅
76-
Use CodeQue ESLint plugin to create custom rules in zero time.
7779

78-
Mark errors or warnings tailored to your codebase to enforce common coding standards in your team.
80+
Using CodeQue ESLint plugin you can create your own custom linting rules in zero time.
81+
82+
Custom ESLint rules can help execute on long-term refactors or prevent introducing codebase specific bugs or bad patterns.
83+
84+
Rules can replace your decision log and help standardizing coding conventions across the project or organization.
85+
86+
CodeQue ESLint integration is a no-brainier for any team willing to improve their codebase quality.
87+
88+
<!-- ESLINT INTRO END -->
7989

8090
Installation 👇
8191

@@ -131,3 +141,12 @@ codeque
131141

132142
Find more info in [`@codeque/cli` package docs](./packages/cli/README.md)
133143

144+
<!-- FOOTER START -->
145+
146+
## Support and feedback
147+
148+
Feel free to use [Github Issues](https://github.com/codeque-co/codeque/issues)
149+
to
150+
- ask for help with writing a query
151+
- report a bug or doubt
152+
- suggest feature or improvement

‎package.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
"typecheck": "yarn workspaces run typecheck",
2828
"test": "yarn workspaces run test",
2929
"checks": "yarn typecheck && yarn lint && yarn test",
30-
"postinstall": "node fix-framer-motion.js"
30+
"postinstall": "node fix-framer-motion.js",
31+
"syncReadmes": "node ./syncReadmes.js"
3132
}
3233
}

‎packages/cli/README.md‎

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ It matches code structurally which makes it excellent for more complex queries.
2424

2525
Query language offers wildcards, partial matching and ignores code formatting.
2626

27-
Structural search is available for JavaScript, TypesScript, HTML, CSS and more soon.
27+
Structural code search is available for JavaScript, TypesScript, HTML, CSS and more soon.
2828

29-
Text 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"><b>Give it a try in
3232
playground</b></a></p>
@@ -39,17 +39,18 @@ CodeQue is available as:
3939

4040
- [VSCode extension](https://marketplace.visualstudio.com/items?itemName=CodeQue.codeque) for enhanced code search and navigation experience.
4141
- [ESLint integration](https://www.npmjs.com/package/@codeque/eslint-plugin) for creating custom linting rules in zero time.
42-
- [CLI tool](https://www.npmjs.com/package/@codeque/cli) for searching code and more, also in headless environments.
42+
- [CLI tool](https://www.npmjs.com/package/@codeque/cli) for searching code and more including headless environments.
4343

4444
CodeQue will be soon available as:
4545

4646
- Duplicated code identification
4747
- Batch code refactoring
48-
- Advanced ESLint rules generator
48+
- Advanced ESLint rules creator
4949

50-
</br>
5150

52-
<p align="center"><a href="https://codeque.co/playground"> 🔔 Get notified 🔔 </a></p>
51+
<p align="center"><a href="https://jayu.dev/newsletter"><b>🔔 Get notified 🔔 </b></a></p>
52+
53+
<p align="center"><i>All CodeQue tools <b>operate offline</b> hence code never leaves your local environment.</i></p>
5354

5455
</br>
5556

@@ -178,3 +179,13 @@ codeque [options]
178179
- `-ogi, --omitGitIgnore` - Search files regardless .gitignore settings (_optional_)
179180
- `-ae, --allExtensions` - Search in all file extensions. Useful for text search mode. (_optional_)
180181
<!-- cli-docs-end -->
182+
183+
<!-- FOOTER START -->
184+
185+
## Support and feedback
186+
187+
Feel free to use [Github Issues](https://github.com/codeque-co/codeque/issues)
188+
to
189+
- ask for help with writing a query
190+
- report a bug or doubt
191+
- suggest feature or improvement

‎packages/core/README.md‎

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ It matches code structurally which makes it excellent for more complex queries.
2424

2525
Query language offers wildcards, partial matching and ignores code formatting.
2626

27-
Structural search is available for JavaScript, TypesScript, HTML, CSS and more soon.
27+
Structural code search is available for JavaScript, TypesScript, HTML, CSS and more soon.
2828

29-
Text 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"><b>Give it a try in
3232
playground</b></a></p>
@@ -39,27 +39,37 @@ CodeQue is available as:
3939

4040
- [VSCode extension](https://marketplace.visualstudio.com/items?itemName=CodeQue.codeque) for enhanced code search and navigation experience.
4141
- [ESLint integration](https://www.npmjs.com/package/@codeque/eslint-plugin) for creating custom linting rules in zero time.
42-
- [CLI tool](https://www.npmjs.com/package/@codeque/cli) for searching code and more, also in headless environments.
42+
- [CLI tool](https://www.npmjs.com/package/@codeque/cli) for searching code and more including headless environments.
4343

4444
CodeQue will be soon available as:
4545

4646
- Duplicated code identification
4747
- Batch code refactoring
48-
- Advanced ESLint rules generator
48+
- Advanced ESLint rules creator
4949

50-
</br>
5150

52-
<p align="center"><a href="https://codeque.co/playground"> 🔔 Get notified 🔔 </a></p>
51+
<p align="center"><a href="https://jayu.dev/newsletter"><b>🔔 Get notified 🔔 </b></a></p>
52+
53+
<p align="center"><i>All CodeQue tools <b>operate offline</b> hence code never leaves your local environment.</i></p>
5354

5455
</br>
5556

5657
<!-- HERO END -->
5758

58-
5959
## `@codeque/core`
6060

6161
It's internal package and it's not meant to be used directly.
6262

6363
The exposed API might have breaking changes between releases.
6464

65-
To use CodeQue check available platforms listed above.
65+
To use CodeQue check available platforms listed above.
66+
67+
<!-- FOOTER START -->
68+
69+
## Support and feedback
70+
71+
Feel free to use [Github Issues](https://github.com/codeque-co/codeque/issues)
72+
to
73+
- ask for help with writing a query
74+
- report a bug or doubt
75+
- suggest feature or improvement

‎packages/eslint/README.md‎

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ It matches code structurally which makes it excellent for more complex queries.
2424

2525
Query language offers wildcards, partial matching and ignores code formatting.
2626

27-
Structural search is available for JavaScript, TypesScript, HTML, CSS and more soon.
27+
Structural code search is available for JavaScript, TypesScript, HTML, CSS and more soon.
2828

29-
Text 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"><b>Give it a try in
3232
playground</b></a></p>
@@ -39,31 +39,35 @@ CodeQue is available as:
3939

4040
- [VSCode extension](https://marketplace.visualstudio.com/items?itemName=CodeQue.codeque) for enhanced code search and navigation experience.
4141
- [ESLint integration](https://www.npmjs.com/package/@codeque/eslint-plugin) for creating custom linting rules in zero time.
42-
- [CLI tool](https://www.npmjs.com/package/@codeque/cli) for searching code and more, also in headless environments.
42+
- [CLI tool](https://www.npmjs.com/package/@codeque/cli) for searching code and more including headless environments.
4343

4444
CodeQue will be soon available as:
4545

4646
- Duplicated code identification
4747
- Batch code refactoring
48-
- Advanced ESLint rules generator
48+
- Advanced ESLint rules creator
4949

50-
</br>
5150

52-
<p align="center"><a href="https://codeque.co/playground"> 🔔 Get notified 🔔 </a></p>
51+
<p align="center"><a href="https://jayu.dev/newsletter"><b>🔔 Get notified 🔔 </b></a></p>
52+
53+
<p align="center"><i>All CodeQue tools <b>operate offline</b> hence code never leaves your local environment.</i></p>
5354

5455
</br>
5556

5657
<!-- HERO END -->
57-
58+
59+
<!-- ESLINT INTRO START -->
5860
## ESLint integration 💅
5961

6062
Using CodeQue ESLint plugin you can create your own custom linting rules in zero time.
6163

6264
Custom ESLint rules can help execute on long-term refactors or prevent introducing codebase specific bugs or bad patterns.
6365

64-
Rules can replace your decision log and help standardizing coding conventions across the project.
66+
Rules can replace your decision log and help standardizing coding conventions across the project or organization.
67+
68+
CodeQue ESLint integration is a no-brainier for any team willing to improve their codebase quality.
6569

66-
CodeQue is a no-brainier for any team willing to improve their codebase quality.
70+
<!-- ESLINT INTRO END -->
6771

6872
## Installation
6973

@@ -169,4 +173,14 @@ Plugin collects completely anonymous telemetry that helps me get insights about
169173
170174
It's implemented using `applicationinsights` and you can easily opt-out.
171175
172-
Learn more about [telemetry](https://codeque.co/docs/telemetry#es-lint-plugin)
176+
Learn more about [telemetry](https://codeque.co/docs/telemetry#es-lint-plugin)
177+
178+
<!-- FOOTER START -->
179+
180+
## Support and feedback
181+
182+
Feel free to use [Github Issues](https://github.com/codeque-co/codeque/issues)
183+
to
184+
- ask for help with writing a query
185+
- report a bug or doubt
186+
- suggest feature or improvement

‎packages/vscode/README.md‎

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ It matches code structurally which makes it excellent for more complex queries.
2424

2525
Query language offers wildcards, partial matching and ignores code formatting.
2626

27-
Structural search is available for JavaScript, TypesScript, HTML, CSS and more soon.
27+
Structural code search is available for JavaScript, TypesScript, HTML, CSS and more soon.
2828

29-
Text 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"><b>Give it a try in
3232
playground</b></a></p>
@@ -39,17 +39,18 @@ CodeQue is available as:
3939

4040
- [VSCode extension](https://marketplace.visualstudio.com/items?itemName=CodeQue.codeque) for enhanced code search and navigation experience.
4141
- [ESLint integration](https://www.npmjs.com/package/@codeque/eslint-plugin) for creating custom linting rules in zero time.
42-
- [CLI tool](https://www.npmjs.com/package/@codeque/cli) for searching code, creating git hooks and more.
42+
- [CLI tool](https://www.npmjs.com/package/@codeque/cli) for searching code and more including headless environments.
4343

4444
CodeQue will be soon available as:
4545

4646
- Duplicated code identification
4747
- Batch code refactoring
48-
- Advanced ESLint rules generator
48+
- Advanced ESLint rules creator
4949

50-
</br>
5150

52-
<p align="center"><a href="https://codeque.co/playground"> 🔔 Get notified 🔔 </a></p>
51+
<p align="center"><a href="https://jayu.dev/newsletter"><b>🔔 Get notified 🔔 </b></a></p>
52+
53+
<p align="center"><i>All CodeQue tools <b>operate offline</b> hence code never leaves your local environment.</i></p>
5354

5455
</br>
5556

@@ -58,13 +59,11 @@ CodeQue will be soon available as:
5859
## CodeQue - multiline and structural code search for Visual Studio Code
5960
VSCode extension aims to improve code search and navigation experience.
6061

61-
62-
63-
Advanced search options and todo-like list of accurate search results makes it your new super power.
62+
Advanced code search options and todo-like list of accurate search results makes it your new super power.
6463

6564
CodeQue supports multiline code search for every programming language and structural code search for JavaScript and TypeScript.
6665

67-
Structural search support for other programming languages will be added soon.
66+
Structural code search support for other programming languages will be added soon.
6867

6968
</br>
7069

@@ -245,7 +244,7 @@ You can check search error details in tooltip available after click the error co
245244

246245
## Query examples
247246

248-
CodeQue is general purpose search tool. The examples list could be endless. Here are some of them for you to get a glimpse of what's possible. Those are relatively simple, you definitely would find some more complex during day to day work.
247+
CodeQue is general purpose code search tool. The examples list could be endless. Here are some of them for you to get a glimpse of what's possible. Those are relatively simple, you definitely would find some more complex during day to day work.
249248

250249
> Don't know how to write a query? [Open an issue on GitHub](https://github.com/codeque-co/codeque/issues) !
251250
@@ -281,7 +280,7 @@ More specifically it will match all objects with at least one address entry with
281280
282281
### React component with specific props combination
283282

284-
I found it very useful to find props with specific props combination. Sometimes props depends on each other and we might want to refactor some of them, but how do we determine whether they are used together? We can review long list of results for basic search, but who has time for that 😉
283+
I found it very useful to find props with specific props combination. Sometimes props depends on each other and we might want to refactor some of them, but how do we determine whether they are used together? We can review long list of results for basic code search, but who has time for that 😉
285284

286285
```tsx
287286
<Button
@@ -348,17 +347,20 @@ It's implemented using `@vscode/extension-telemetry` and respects you editor tel
348347

349348
Learn more about [telemetry](https://codeque.co/docs/telemetry#vs-code-extension)
350349

351-
## Support, Feedback and more
352-
353-
Playground 👉 [codeque.co/playground](https://codeque.co/playground)
354-
355-
Bugs, feature requests, help 👉 [Github Issues](https://github.com/codeque-co/codeque/issues)
356-
357-
Documentation 👉 [codeque.co/docs](https://codeque.co/docs)
350+
## Support and feedback
358351

359-
Roadmap 👉 [codeque.co/roadmap](https://codeque.co/roadmap)
352+
Feel free to use [Github Issues](https://github.com/codeque-co/codeque/issues)
353+
to
354+
- ask for help with writing a query
355+
- report a bug or doubt
356+
- suggest feature or improvement
360357

361-
Mission 👉 [codeque.co/mission](https://codeque.co/mission)
358+
<!-- FOOTER START -->
362359

363-
Wanna contribute 👉 [Internal readme](./InternalReadme.md)
360+
## Support and feedback
364361

362+
Feel free to use [Github Issues](https://github.com/codeque-co/codeque/issues)
363+
to
364+
- ask for help with writing a query
365+
- report a bug or doubt
366+
- suggest feature or improvement

‎packages/vscode/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "codeque",
33
"publisher": "CodeQue",
44
"displayName": "CodeQue - Multiline and Structural Code Search",
5-
"description": "Multiline code search for any language. Structural code search for TypeScript and JavaScript",
5+
"description": "Multiline code search for every language. Structural code search for TypeScript, JavaScript, CSS and HTML",
66
"repository": {
77
"type": "git",
88
"url": "https://github.com/codeque-co/codeque"

0 commit comments

Comments
 (0)