Mini-Editor

KO | EN

gitlite — search

#python #react #typescript #llm #golang #deep-learning #nodejs #java #windows #awesome #kubernetes #vue #pytorch #ios

(★ 15)

A 0 dependencies Terminal-based text editor

Mini-Editor Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Mini Editor

Mini (formerly NotVim) Editor is a WIP, custom, 0 dependencies, cross-platform, console-based text editor, currently tested to work on Windows and Linux.

All standard features of a text-editor, with the exception of find/replace, have been implemented and should be bug-free. 
Be sure to check out [Getting Starting](#getting-started)!
<hr>

### Demo

[Mini Editor Demo](https://github.com/user-attachments/assets/ccb2e40c-d786-4dde-bf4f-0d617091cf9d)

<hr>

### Versions
If you would like to try the latest features, you can build the application from the dev branch. However, some features may be experimental, and bugs may arise.

If you would like to use a stable release, check out the releases tab. Releases are tested to be as stable as possible. Some bugs may slip through to releases, so be sure to report those!

<hr>

### Controls

Controls are listed as follows:

WHILE IN READ MODE (Default Mode):
	- i - Enable Edit Mode
	- : - Enable Command Mode
	- f - Enable Find Mode
	
	WHILE IN COMMAND MODE:
	- q: Quit (File must be saved if changes have been made)
	- q!: Force Quit. Don't even check if file has been saved
	- w/s: [W]rite/[S]ave changes
	- wq/sq: [W]rite and [Q]uit / [S]ave and [Q]uit.

WHILE IN EDIT MODE:
	Escape: Go back to Read Mode

MOVEMENT FUNCTIONALITY:
	- ArrowKey Left/Right: Move 1 character left/right within the file.
	- ArrowKey Up/Down: Move one row up/down within the file
	- CtrlArrow Left/Right: Move to the start/end of the previous word/next word
	- CtrlArrow Up/Down: Shift the current view offset by one up/down
	- Home/End: Go to start of/end of current row
	- CtrlHome/End: Go to start of / end of file
	- PageUp/Down: Shift screen position by 1 page/screen rows worth
	- CtrlPage Up/Down: Move cursor to start of/end of screen without adjusting screen position

CHARACTER EDITING:
	- Letter/Number/Symbol: Insert at current cursor position and move cursor forward
 	- Tab: Insert a tab character, equivalent to cursor % 8 spaces. 
	- Enter/Return: Insert a new row, moving contents beyond the cursor onto the new row and move cursor to start of new row
	- Backspace/Delete: Delete character behind/in front of cursor. Move cursor backwards if using backspace.
	- CtrlBackspace/Delete: Delete word
 	- Ctrl+Z: Undo most recent change.
  	- Ctrl+Y: Redo most recent undo.

FIND MODE CONTROLS:
	- Arrow Left/Up: Go to previous find location
	- Enter/Arrow Right/Down: Go to next find location
	- f/Ctrl+F: Edit string to find

OTHER CONTROLS:
	- Ctrl+S: Saves the file while not in command mode.
	- Ctrl+Q: Force quits the program while not in command mode (WARNING: DOES NOT SAVE FILE).
	- Ctrl+F: Enter Find Mode while not in command mode

More key functionality will be added as this project progresses.

<hr>

### Syntax Highlighting

Currently, the provided config.json only supports C++ files (.cc, .cpp, .hpp, .h, .hh, etc.), but configurations for other languages will be provided soon! Feel free to add your own addition to the config for your favorite language!

Syntax highlights are generated using a custom token system, which stores the highlight type, starting position, and ending position. For multiline highlights, including strings and multiline comments,
the token also stores if the ending position exists, or if the rest of the file should just have the same highlight.

![image](https://github.com/user-attachments/assets/c1a5efd0-996f-4f5f-8dae-d87293c9a905)

<hr>

### Configuring Syntax Highlighting

There is a config.json file for configuring the syntax highlighting to your heart's content! All you need to do is make sure the config.json file is in the same directory as 
the mini executable. From there, all your configurations get loaded, and depending on the file extension, the proper syntax is configured!

The list of pre-selected colors are:

pink, magenta, hotpink, rosered, lightred, red, darkred, darkorange,
	peach, orange, lightorange, lightyellow, marigoldyellow, yellow,
	darkyellow, darklimegreen, lightgreen, green, darkgreen, tealgreen,
	teal, tealblue, lightblue, seablue, blue, navyblue, darkblue,
	purple, darkpurple, lightgray, gray, white, and black

If you would like to change/add your own colors, all you need to do is add/change a couple things in the SyntaxHighlight.hpp file.

At the bottom of the file, you will find something that looks like

```
	inline static const std::unordered_map<std::string, uint8_t> mColorKeys{
		//Color values here
	}
```

To add a new color, just navigate to the [link](https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797#:~:text=Where%20%7BID%7D%20should%20be%20replaced%20with%20the%20color%20index%20from%200%20to%20255%20of%20the%20following%20color%20table%3A),
find the color id that suits you, give it a unique name, and enter the id found on the site. To change existing colors, just change the number and/or the name.

Make sure that the values you put in the config.json file exist in the colorKey map.

The layout for the config.json file is as follows:

{
		"syntaxName" (can be anything, eg "cpp"): {
			"fileExtensions": [ //File extensions. E.g.: ".cpp", ".cc"], (REQUIRED)
			"defaultColor": "colorValue", (OPTIONAL, DEFAULT IS WHITE)
			"builtInKeywords": { (OPTIONAL)
				"keywords": [ (REQUIRED IF builtInKeywords exists)
					//All keywords for your language
				],
				"color": "colorValue" (REQUIRED IF builtInKeywords exists)
			},
			"controlKeywords": { (OPTIONAL)
				//Follows same structure as builtInKeywords
			},
			"otherKeywords": { (OPTIONAL)
				//Follows same structure as builtInKeywords
			},
			"multiLineComment" { (OPTIONAL) (DEFAULTS TO "/*" for start marker, and "*/" for end marker, with GREEN default color)
				"start": "startMarker [such as /*]", (REQUIRED IF multiLineComment exists)
				"end": "endMarker [such as */]", (REQUIRED IF multiLineComment exists)
				"color": "colorValue" (REQUIRED IF multiLineComment exists)
			},
			"singleLineComment": { (OPTIONAL) (DEFAULTS TO "//" with LIMEGREEN default color)
				"identifier": "marker [such as //]", (REQUIRED IF singleLineComment exists)
				"color": "colorValue" (REQUIRED IF singleLineComment exists)
			},
			"number": { (OPTIONAL, color defaults to SEABLUE)
				"color": "colorValue" (REQUIRED IF number EXISTS)
			},
			"string": { (OPTIONAL, color defaults to ORANGE)
				"color": "colorValue" (REQUIRED IF string EXISTS)
			},
			"escapeChar": "escapeCharValue [such as \\]" (OPTIONAL, defaults to \\)
		},
		"newSyntax": {
			//Repeat the process
		}
	}

Order of keys inside the syntax object does not matter, only thing that matters is that all required keys exist.

<hr>

### Getting Started

If you are on Windows and would like to try this out right away, head to the releases tab and download the mini.exe file. This is the standalone program executable.
Check out [Usage](#usage) to learn how to use it!

Be sure to check out [Building](#building) if you would like to build the project for yourself!

If you would like to contribute, check out [Contributing](#contributing)!

<hr>

### Building

A CMake Build script is provided. CMake 3.12, as well as a C++20 compliant compiler is required. A python script to automate the cmake build process is also provided, if you have Python installed.

To build with the Python script, run

python build.py

This will build the project into the folder path ./out/build

To build this project with the tests, run

python build.py --build-tests

To build only the tests with the python script, run

python build.py --tests-only

To build manually, run

cmake -B {buildDir} -G {buildGenerator} -S {pathToCMakeScript}

cmake --build {buildDir} --config Release

EXAMPLE (While in root dir):

cmake -B ./out -G Ninja

cmake --build ./out --config Release

To build manually with tests, run the following instead

cmake -B {buildDir} -G {buildGenerator} -S {pathToCMakeScript} -DBUILD_TESTS=ON
	
	EXAMPLE:
	
	cmake -B ./out -G Ninja -DBUILD_TESTS=ON
	
	cmake --build ./out --config Release

To build manually with only tests, run

cmake -B {buildDir} -G {buildGenerator} -S {pathToCMakeScript} -DBUILD_TESTS=ON -DBUILD_PROJECT=OFF

cmake --build {buildDir} --config Release

<hr>

### Usage

To use, navigate to the executable (either in {buildDir} or {buildDir}/bin most commonly). Then, run

./mini <filename.fileExtension>

OR IF USING COMMAND PROMPT

mini <filename.fileExtension>

EXAMPLE:

./mini test.cpp

This executable is a standalone executable, so you may also add this file to your system path and use it from anywhere

To run the tests, navigate to the Tests executable (located in {buildDir}/tests, or {buildDir}/tests/Release).

Run it by doing

./Tests

OR IF USING COMMAND PROMPT

Tests

> **_NOTE:_** For tests to run properly, you must be in the directory containing the Tests executable. Some tests will fail if you do not run it from the directory, since it requires files relative to the Tests.exe file

<hr>

### Known Bugs

Check the issues page to see all known bugs

<hr>

### Contributing

I am welcome to any and all who want to contribute! Pushing to the master branch is restricted (for obvious reasons, lol). If you would like to contribute, 
just clone the repo, make a new branch, and implement whatever features you would like! You can also fork this repo and contribute that way. All changes must be approved by me, 
as I am the sole maintainer of this project.

<hr>

#### UNTESTED ON OSX (macOS). 
 
From my understanding, this should still work on mac due to the Unix based nature of it, but it is untested.

Mini-Editor

Mini-Editor Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Mini-Editor

Mini-Editor Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README