Skip to content

Commit 24500b6

Browse files
codekilncodekiln
committed
Add Repomix configuration documentation and JavaScript/JSON5 reference pages
- Create new pages for Repomix configuration with detailed JSON5 config options - Add ECMAScript 5 and 5.1 reference pages - Create JSON5 page with overview, examples, and usage details - Update journal entry with Repomix and coding language tool references
1 parent 9ff7296 commit 24500b6

File tree

6 files changed

+128
-12
lines changed

6 files changed

+128
-12
lines changed

‎journals/2025_03_05.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
## [[AI Coding]]
22
- ### [[AI/LLM/Tool/Repo Summarizer]] #Filed
3-
- #Discovered [[Tree-Sitter]] because it's used by [[Repomix/--compress]] to shrink code context
4-
- {{embed ((67c7f234-c55c-4b12-a260-d92aa3cfbb0c))}}
3+
- #### [[Repomix/Config]]
4+
- added some documentation on repomix config
55
- [[Webinar]] with [[QodoAI]] [[2025-03-11 Tue]] 9AM PST / 12PM EDT / 4PM GMT with [[Person/Itamar Friedman]] and [[Person/Harrison Chase]] - [Webinar: From Code Completion to Multi-Agent Coding Workflows](https://www.qodo.ai/webinar/from-code-completion-to-multi-agent-coding-workflows/)
6+
- ## Coding Language Tools
7+
- [[JSON5]]
8+
- {{embed ((67c822b0-3271-41da-a14f-4f023a1f4556))}}
9+
- [[Tree-Sitter]]
10+
- #Discovered via [[Repomix/--compress]] which uses it to shrink code context
11+
- {{embed ((67c7f234-c55c-4b12-a260-d92aa3cfbb0c))}}
612
- ## [[Microsoft]] ecosystem
713
- [[o365/pptx/How To/Embed MS Stream in PowerPoint]]

‎pages/JS___ES___5.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
alias:: [[ES5]], [[ECMAScript 5]]
2+
3+
- # ECMAScript 5
4+
- ## [[see-also]]
5+
- [[JS/ES/5/1]]

‎pages/JS___ES___5___1.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
alias:: [[ECMAScript 5.1]]
2+
date-created:: [[2011/06]]
3+
4+
- # [ECMAScript Language Specification - ECMA-262 Edition 5.1](https://262.ecma-international.org/5.1/)
5+
- Standard ECMA-262
6+
-

‎pages/Repomix.md‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,18 @@ tags:: #LLMs, [[CLI/Tool]], [[AI/LLM/Tool/Repo Summarizer]]
88
- [[Repomix/Web]] https://repomix.com/
99
- This tool can be used online
1010
- ## Usage
11-
- ## Using with a config file
12-
- To use Repomix with a specific configuration file, use the following command:
13-
~~~bash
14-
npx repomix --config path/to/repomix.config.json
15-
~~~
16-
- This will generate the output based on the settings in your configuration file
17-
- The config file allows you to customize:
18-
- Which files to include/exclude
19-
- Output format
20-
- Repository metadata
11+
- ## [[Repomix/Config]]
12+
- ### Specifying a Config File
13+
- To use Repomix with a specific configuration file, use the following command:
14+
~~~bash
15+
npx repomix --config path/to/repomix.config.json
16+
~~~
17+
- This will generate the output based on the settings in your configuration file
18+
- The config file allows you to customize:
19+
- Which files to include/exclude
20+
- Output format
21+
- Repository metadata
22+
- See also [[Repomix/repomix.config.json]] for options
2123
- ## [[see-also]]
2224
- [[gitingest]]
2325
-

‎pages/Repomix___Config.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
alias:: [[Repomix/repomix.config.json]]
2+
3+
- # Repomix Config
4+
- The config file is in [[JSON5]] which means it can have [[Code/Comments]] in it
5+
- ## Config File Options
6+
- [[Repomix/Config/output/filePath]]
7+
- The name of the output file (default: `"repomix-output.txt"`)
8+
- [[Repomix/Config/output/style]]
9+
- The style of the output (`plain`, `xml`, `markdown`) (default: `"plain"`)
10+
- [[Repomix/Config/output/headerText]]
11+
- Custom text to include in the file header (default: `null`)
12+
- [[Repomix/Config/output/instructionFilePath]]
13+
- Path to a file containing detailed custom instructions (default: `null`)
14+
- [[Repomix/Config/output/removeComments]]
15+
- Whether to remove comments from supported file types (default: `false`)
16+
- [[Repomix/Config/output/removeEmptyLines]]
17+
- Whether to remove empty lines from the output (default: `false`)
18+
- [[Repomix/Config/output/showLineNumbers]]
19+
- Whether to add line numbers to each line in the output (default: `false`)
20+
- [[Repomix/Config/output/copyToClipboard]]
21+
- Whether to copy the output to system clipboard in addition to saving the file (default: `false`)
22+
- [[Repomix/Config/output/topFilesLength]]
23+
- Number of top files to display in the summary. If set to 0, no summary will be displayed (default: `5`)
24+
- [[Repomix/Config/include]]
25+
- Patterns of files to include (using [glob patterns](https://github.com/mrmlnc/fast-glob?tab=readme-ov-file#pattern-syntax)) (default: `[]`)
26+
- [[Repomix/Config/ignore/useGitignore]]
27+
- Whether to use patterns from the project's `.gitignore` file (default: `true`)
28+
- [[Repomix/Config/ignore/useDefaultPatterns]]
29+
- Whether to use default ignore patterns (default: `true`)
30+
- see [defaultIgnore.ts](https://github.com/yamadashy/repomix/blob/main/src/config/defaultIgnore.ts) for more details.
31+
- [[Repomix/Config/ignore/customPatterns]]
32+
- Additional patterns to ignore (using [glob patterns](https://github.com/mrmlnc/fast-glob?tab=readme-ov-file#pattern-syntax)) (default: `[]`)
33+
- [[Repomix/Config/security/enableSecurityCheck]]
34+
- Whether to perform security checks on files (default: `true`)
35+
- ## #Example Configuration
36+
- ~~~json
37+
{
38+
"output": {
39+
"filePath": "repomix-output.xml",
40+
"style": "xml",
41+
"parsableStyle": true,
42+
"compress": false,
43+
"headerText": "Custom header information for the packed file.",
44+
"fileSummary": true,
45+
"directoryStructure": true,
46+
"removeComments": false,
47+
"removeEmptyLines": false,
48+
"showLineNumbers": false,
49+
"copyToClipboard": true,
50+
"topFilesLength": 5,
51+
"includeEmptyDirectories": false,
52+
},
53+
"include": [
54+
"**/*"
55+
],
56+
"ignore": {
57+
"useGitignore": true,
58+
"useDefaultPatterns": true,
59+
// Patterns can also be specified in .repomixignore
60+
"customPatterns": [
61+
"additional-folder",
62+
"**/*.log"
63+
],
64+
},
65+
"security": {
66+
"enableSecurityCheck": true
67+
},
68+
"tokenCount": {
69+
"encoding": "o200k_base"
70+
},
71+
}
72+
~~~

‎pages/json___5.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
alias:: [[JSON5]]
2+
3+
- # [JSON5 – JSON for Humans | JSON5](https://json5.org/)
4+
- ## About
5+
id:: 67c822b0-3271-41da-a14f-4f023a1f4556
6+
- extension to [[json]] that **aims to be easier to write and maintain by hand (e.g. for config files)**. ([[Code/Comments]] allowed)
7+
- superset of [[json]]; valid JSON files will always be valid JSON5 files
8+
- a subset of [[ES5]]; valid JSON5 files will always be valid ES5
9+
- expands its syntax to include some productions from [ECMAScript 5.1](https://www.ecma-international.org/ecma-262/5.1/) (ES5).
10+
- ## #Example
11+
- ```json5
12+
{
13+
// comments
14+
unquoted: 'and you can quote me on that',
15+
singleQuotes: 'I can use "double quotes" here',
16+
lineBreaks: "Look, Mom! \
17+
No \\n's!",
18+
hexadecimal: 0xdecaf,
19+
leadingDecimalPoint: .8675309, andTrailing: 8675309.,
20+
positiveSign: +1,
21+
trailingComma: 'in objects', andIn: ['arrays',],
22+
"backwardsCompatible": "with JSON",
23+
}
24+
```
25+
- started in [[2012]], and as of [[2022]], gets [>65M downloads/week](https://www.npmjs.com/package/json5), ranks in the [top 0.1%](https://gist.github.com/anvaka/8e8fa57c7ee1350e3491) of the most depended-upon packages on npm, and has been adopted by major projects like [Chromium](https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/platform/runtime_enabled_features.json5;drc=5de823b36e68fd99009a29281b17bc3a1d6b329c), [Next.js](https://github.com/vercel/next.js/blob/b88f20c90bf4659b8ad5cb2a27956005eac2c7e8/packages/next/lib/find-config.ts#L43-L46), [Babel](https://babeljs.io/docs/en/config-files#supported-file-extensions), [Retool](https://community.retool.com/t/i-am-attempting-to-append-several-text-fields-to-a-google-sheet-but-receiving-a-json5-invalid-character-error/7626), [WebStorm](https://www.jetbrains.com/help/webstorm/json.html), and [more](https://github.com/json5/json5/wiki/In-the-Wild). It's also natively supported on [Apple platforms](https://developer.apple.com/documentation/foundation/jsondecoder/3766916-allowsjson5) like [[MacOS]] and [[iOS]].

0 commit comments

Comments
 (0)