Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 52 additions & 46 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -1,46 +1,52 @@
{
"extends": [
"eslint:recommended",
"plugin:node/recommended",
"prettier"
],
"env": {
"node": true,
"es6": true
},
"parserOptions": {
"ecmaVersion": 2023,
"sourceType": "module"
},
"rules": {
"no-unused-vars": 1,
"valid-jsdoc": ["warn", {
"requireReturn": false,
"requireReturnDescription": false,
"preferType": {
"String": "string",
"Number": "number",
"Boolean": "boolean",
"Symbol": "symbol",
"function": "Function",
"object": "Object",
"date": "Date",
"error": "Error"
}
}],
"semi": ["error", "always"],
"indent": ["error", 2, {"SwitchCase": 1}],
"comma-dangle": ["error", "always-multiline"],
"keyword-spacing": ["error", {
"overrides": {
"if": { "after": true },
"for": { "after": true },
"while": { "after": true },
"catch": { "after": true },
"switch": { "after": true }
}
}],
"quotes": ["error", "single", { "avoidEscape": true, "allowTemplateLiterals": true }],
"template-curly-spacing": "error"
}
}
{
"extends": ["eslint:recommended", "plugin:node/recommended", "prettier"],
"env": {
"node": true,
"es6": true
},
"parserOptions": {
"ecmaVersion": 2023,
"sourceType": "module"
},
"rules": {
"no-unused-vars": 1,
"valid-jsdoc": [
"warn",
{
"requireReturn": false,
"requireReturnDescription": false,
"preferType": {
"String": "string",
"Number": "number",
"Boolean": "boolean",
"Symbol": "symbol",
"function": "Function",
"object": "Object",
"date": "Date",
"error": "Error"
}
}
],
"semi": ["error", "always"],
"indent": ["error", 2, { "SwitchCase": 1 }],
"comma-dangle": ["error", "always-multiline"],
"keyword-spacing": [
"error",
{
"overrides": {
"if": { "after": true },
"for": { "after": true },
"while": { "after": true },
"catch": { "after": true },
"switch": { "after": true }
}
}
],
"quotes": [
"error",
"single",
{ "avoidEscape": true, "allowTemplateLiterals": true }
],
"template-curly-spacing": "error"
}
}
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
- how to run in dev
- how to test using npm link
- updating tests
- running docs
- retype needs `npm install retypeapp --global` to work.
- running docs
- retype needs `npm install retypeapp --global` to work.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,23 @@
</div>

<div align="center">
<p><img src="https://alterion.dev/enmap-logo.svg" alt="Enmap Logo" />
<p><img src="https://enmap.alterion.dev/assets/enmap-logo.svg" alt="Enmap Logo" />
</div>

Enmap is a simple and efficient wrapper around SQLite, based around the idea of being a Map() with additional array methods added on to it.

Enmap is:
Enmap is:

- **Anti-ORM**, in that it can store any serializable data, and each value can be of a different shape. Compared to an ORM which strictly defines a shape for your data.
- Fully **typescript compatible**. Accepts generics if you *do* want to define a data shape for your own code. Return values are properly typed according to your generics if provided.
- Fully **typescript compatible**. Accepts generics if you _do_ want to define a data shape for your own code. Return values are properly typed according to your generics if provided.
- **Synchronous**. Meaning, it doesn't use callbacks or promises, no await, no .then, just call the method and go. This is thanks to [better-sqlite3][https://npm.im/better-sqlite3]!
- **Modern and maintained**. I try to keep up to date with dependency updates, too add new functionality, and resolve issues, as fast as I can. Even if there's months where I don't update Enmap, it is not abandonned.

## Documentation

* [Installation](https://enmap.alterion.dev/install)
* [Basic Setup](https://enmap.alterion.dev/usage)
* [API Reference](https://enmap.alterion.dev/api)
- [Installation](https://enmap.alterion.dev/install)
- [Basic Setup](https://enmap.alterion.dev/usage)
- [API Reference](https://enmap.alterion.dev/api)

## Support

Expand Down Expand Up @@ -65,7 +65,7 @@ Some user comments!
> I know how to use a real db, but enmap is so sweet and easy to use

> Thanks to Enmap, I am able to do tons of things that I never thought I would accomplish.
From custom settings to even just saving the little things, it is amazing to use.
> From custom settings to even just saving the little things, it is amazing to use.

> Enmap helped me, and it stills helps me, because it is very simple and useful. Thank you for creating Enmap.

Expand Down
Loading