You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-12Lines changed: 16 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,17 +65,21 @@ For more screenshots checkout
65
65
66
66
### Folder / Project Settings (\*)
67
67
68
-
*ecode* treats folders as projects, like many other editors. The main difference is that it also tries
69
-
to automatically sanitize the project files by filtering out any file that it's filtered in the repository
70
-
`.gitignore` files. The idea is to use the `.gitignore` file as a project setting.
71
-
The project files will be the ones used to find files in the project and do global searches.
72
-
Usually, this translates into much better results for any project-related search.
73
-
There's also a very simple mechanism to allow visibility of filtered files by the `.gitignore`, by
74
-
adding a file with the allowed filtered patterns in a subfolder over the folder loaded, creating a file
75
-
in `.ecode/.prjallowed` with the necessary glob patterns allowing the filtered patterns to be "unfiltered".
76
-
It's also possible achieving the inverse operation (ignoring a file that it's not being gitignored) with the `.ecode/.prjdisallowed` file.
77
-
ecode will only add files that are supported by the editor, the editor won't try to do anything
78
-
with files that are not officially supported.
68
+
In *ecode*, folders are treated as projects, similar to other code editors. However, *ecode* distinguishes itself by using the repository's `.gitignore` file as a project configuration to streamline file management.
69
+
70
+
#### Automatic File Filtering
71
+
*ecode* automatically excludes files listed in the `.gitignore` file when indexing project files. This ensures that only relevant files are considered for project-wide searches and navigation, resulting in faster and more accurate search outcomes.
72
+
73
+
#### Customizing File Inclusion
74
+
To override `.gitignore` filtering, *ecode* supports two configuration files in the `.ecode/` subfolder:
75
+
76
+
-**`.prjallowed`**: Add glob patterns to include files ignored by `.gitignore`, making them available for indexing and searching.
77
+
-**`.prjdisallowed`**: Add glob patterns to exclude files that are not ignored by `.gitignore`, providing precise control over file visibility.
78
+
79
+
#### Supported File Types
80
+
By default, *ecode* indexes only file types it officially supports. Unsupported files are excluded unless their patterns are explicitly added to the `.ecode/.prjallowed` file.
81
+
82
+
This approach ensures an efficient and tailored project management experience with flexible customization options.
79
83
80
84
## Philosophy
81
85
@@ -100,7 +104,7 @@ there. But you can give it a try:
100
104
### Demo Clarifications
101
105
102
106
* You'll need a modern browser with [SharedArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer#browser_compatibility) support
103
-
* Linter, Formatter,, LSP Client and Debugger plugins won't work since they work by running other processes (except for the native formatters that are available)
107
+
* Linter, Formatter, LSP Client and Debugger plugins won't work since they work by running other processes (except for the native formatters that are available)
104
108
* WebGL renderer isn't optimized, so it's not as fast as it could/should be (still, performance is good in chromium based browsers)
105
109
* Demo is designed for desktop resolutions (mobile is unusable, IME keyboard won't show up due to an emscripten limitation)
0 commit comments