Skip to content

Commit 3b169c7

Browse files
damms005damms005
committed
Refactor and cleanup
1 parent 5cd1151 commit 3b169c7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+11473
-8
lines changed

‎.eslintrc.json

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"root": true,
3+
"parser": "@typescript-eslint/parser",
4+
"parserOptions": {
5+
"ecmaVersion": 6,
6+
"sourceType": "module"
7+
},
8+
"plugins": [
9+
"@typescript-eslint"
10+
],
11+
"rules": {
12+
"@typescript-eslint/naming-convention": "off",
13+
"@typescript-eslint/semi": "off",
14+
"curly": "off",
15+
"no-throw-literal": "warn",
16+
"semi": "off"
17+
},
18+
"ignorePatterns": [
19+
"out",
20+
"dist",
21+
"**/*.d.ts"
22+
]
23+
}

‎.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
out
2+
dist
3+
node_modules
4+
.vscode-test/
5+
*.vsix

‎.vscode/extensions.json

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
// See http://go.microsoft.com/fwlink/?LinkId=827846
3+
// for the documentation about the extensions.json format
4+
"recommendations": [
5+
"dbaeumer.vscode-eslint"
6+
]
7+
}

‎.vscode/launch.json

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// A launch configuration that compiles the extension and then opens it inside a new window
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5+
{
6+
"version": "0.2.0",
7+
"configurations": [
8+
{
9+
"name": "Run Extension",
10+
"type": "extensionHost",
11+
"request": "launch",
12+
"args": ["--extensionDevelopmentPath=${workspaceFolder}", "--disable-extensions"],
13+
"outFiles": ["${workspaceFolder}/out/**/*.js"],
14+
"preLaunchTask": "${defaultBuildTask}"
15+
},
16+
{
17+
"name": "Extension Tests",
18+
"type": "extensionHost",
19+
"request": "launch",
20+
"args": ["--extensionDevelopmentPath=${workspaceFolder}", "--extensionTestsPath=${workspaceFolder}/out/test/suite/index", "--disable-extensions"],
21+
"outFiles": ["${workspaceFolder}/out/test/**/*.js"],
22+
"preLaunchTask": "${defaultBuildTask}"
23+
}
24+
]
25+
}

‎.vscode/settings.json

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// Place your settings in this file to overwrite default and user settings.
2+
{
3+
"files.exclude": {
4+
"out": false // set this to true to hide the "out" folder with the compiled JS files
5+
},
6+
"search.exclude": {
7+
"out": true // set this to false to include "out" folder in search results
8+
},
9+
// Turn off tsc task auto detection since we have the necessary tasks as npm scripts
10+
"typescript.tsc.autoDetect": "off",
11+
"editor.defaultFormatter": "esbenp.prettier-vscode",
12+
"cSpell.words": [
13+
"devdbrc"
14+
]
15+
}

‎.vscode/tasks.json

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// See https://go.microsoft.com/fwlink/?LinkId=733558
2+
// for the documentation about the tasks.json format
3+
{
4+
"version": "2.0.0",
5+
"tasks": [
6+
{
7+
"type": "npm",
8+
"script": "watch",
9+
"problemMatcher": "$tsc-watch",
10+
"isBackground": true,
11+
"presentation": {
12+
"reveal": "never"
13+
},
14+
"group": {
15+
"kind": "build",
16+
"isDefault": true
17+
}
18+
}
19+
]
20+
}

‎.vscodeignore

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.vscode/**
2+
.vscode-test/**
3+
src/**
4+
.gitignore
5+
.yarnrc
6+
vsc-extension-quickstart.md
7+
**/tsconfig.json
8+
**/.eslintrc.json
9+
**/*.map
10+
**/*.ts

‎CHANGELOG.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Change Log
2+
3+
All notable changes to the "devdb" extension will be documented in this file.
4+
5+
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
6+
7+
## [Unreleased]
8+
9+
- Initial release

‎README.md

+19-8
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,31 @@
11
# DevDB
2-
A VS Code extension that auto-loads your database. Built with 💖 for developers.
2+
A lightweight VS Code extension that auto-loads your database. It provides a beautiful database GUI client experience. Built with 💖 for developers.
33

44
DevDB brings [Convention over Configuration](https://en.wikipedia.org/wiki/Convention_over_configuration) into database management.
55

6-
76
## Why?
7+
Two words: Better DX.
88

9-
Just DX. I want a DB client specifically designed for local development. I believe local develpoment DX should be better than this experience:
10-
1. For any new project, I need to setup db connection in my app, AND in my DB client
11-
2. I sometimes frequently tab in and tab out of them, switching between my IDE and DB client. Sometimes, frequent enough to make me question why I can't view my DB data directly in my IDE
9+
DevDB aims to be a DB GUI client specifically designed for a much better development experience when working with databases.
10+
Specifically, these experiences:
11+
1. For any new project, it is usually required to setup db connection in the app project, **and** then in some other DB client.
12+
2. It is common to frequently tab-in and tab-out of project windows, switching between the IDE and DB client. Sometimes, frequent enough to want to view the DB data directly in the IDE. Think of how you've got your in-built terminal right in the IDE.
1213

14+
Local DX should be better than this.
1315

14-
Also, I find that most of the DB clients are clunky or simply overwhelm with all kinds of bells and whistles. I usually just want to view the data in my database.
16+
Also, most of the DB clients are clunky or simply overwhelming, with bells and whistles that are not really useful during local development flow. Usually, being able to simply _view_ DB data is all that is needed during local development.
1517

16-
Furthermore, I love beautiful UIs. DB clients have evolved to generally not have beautiful UIs.
18+
Furthermore, who doesn't love beautiful UIs? DB clients have evolved to generally not have exciting UIs in my opinion, except just a few with excellent and intuitive UIs.
1719

18-
I want a database GUI tool that lives in my IDE, and mostly auto-detects and connects with my app's database. I want it to be simple, fast, intuitive, and clean.
20+
To address the above, there is a need for a database GUI tool that lives in the IDE, and mostly auto-detects and connects with the database configured in the currently opened workspace. It should be simple, fast, intuitive, and clean.
1921

2022
Hence, DevDB 🚀
23+
24+
## Keybinding
25+
Press `Ctrl+K Ctrl+D` to bring up the view
26+
27+
## Configuration
28+
Do not commit DevDB config file `.devdb.json` to version control.
29+
30+
## Disclaimer
31+
DevDB does not aim to provide feature-parity with popular GUI database clients. This extension is focused at improving working with databased during application development.

0 commit comments

Comments
 (0)