Skip to content

Commit

Permalink
initial release 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
DomMinnich committed Sep 19, 2024
0 parents commit 2f0c909
Show file tree
Hide file tree
Showing 20 changed files with 3,750 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
out
dist
node_modules
.vscode-test/
*.vsix
5 changes: 5 additions & 0 deletions .vscode-test.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { defineConfig } from '@vscode/test-cli';

export default defineConfig({
files: 'out/test/**/*.test.js',
});
8 changes: 8 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
// See http://go.microsoft.com/fwlink/?LinkId=827846
// for the documentation about the extensions.json format
"recommendations": [
"dbaeumer.vscode-eslint",
"ms-vscode.extension-test-runner"
]
}
21 changes: 21 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
// A launch configuration that compiles the extension and then opens it inside a new window
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
{
"version": "0.2.0",
"configurations": [
{
"name": "Run Extension",
"type": "extensionHost",
"request": "launch",
"args": [
"--extensionDevelopmentPath=${workspaceFolder}"
],
"outFiles": [
"${workspaceFolder}/out/**/*.js"
],
"preLaunchTask": "${defaultBuildTask}"
}
]
}
69 changes: 69 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
// Place your settings in this file to overwrite default and user settings.
{
"files.exclude": {
"out": false // set this to true to hide the "out" folder with the compiled JS files
},
"search.exclude": {
"out": true // set this to false to include "out" folder in search results
},
// Turn off tsc task auto detection since we have the necessary tasks as npm scripts
"typescript.tsc.autoDetect": "off",
"workbench.colorCustomizations": {
"[Tomorrow Night Blue]": {
"activityBar.background": "#00ffaa35",
"activityBarBadge.background": "#00b3ff",
"activityBarBadge.foreground": "#000000",
"activityBar.foreground": "#ffffff",
"activityBar.inactiveForeground": "#aeff00",
"activityBar.border": "#aeff00",
"activityBar.activeBorder": "#ffffff",
"activityBar.activeBackground": "#e1ff007b",
"editor.background": "#161616",
"editorGroup.border": "#aeff00",
"editorGroupHeader.tabsBackground": "#00000035",
"tab.activeBackground": "#00ffaa82",
"tab.activeForeground": "#ffffff",
"tab.activeBorder": "#00ffaa",
"tab.border": "#ffffff",
"tab.inactiveBackground": "#005f417d",
"tab.inactiveForeground": "#ffffff",
"tab.unfocusedActiveForeground": "#ffffff",
"tab.unfocusedActiveBackground": "#00000035",
"tab.unfocusedInactiveForeground": "#ffffff",
"tab.unfocusedInactiveBackground": "#00000035",
"panel.background": "#00000035",
"panel.border": "#aeff006d",
"panelTitle.activeBorder": "#aeff003a",
"panelTitle.activeForeground": "#ffffff",
"panelTitle.inactiveForeground": "#ffffff",
"sideBar.background": "#00000035",
"sideBar.border": "#aeff00",
"sideBar.foreground": "#ffffff",
"sideBarSectionHeader.background": "#00000035",
"statusBar.background": "#00000035",
"statusBar.border": "#aeff00",
"statusBar.debuggingBackground": "#00000035",
"statusBar.debuggingForeground": "#ffffff",
"statusBar.debuggingBorder": "#aeff00",
"statusBar.foreground": "#ffffff",
"statusBar.noFolderBackground": "#00000035",
"statusBar.noFolderForeground": "#ffffff",
"statusBar.noFolderBorder": "#aeff00",
"statusBarItem.activeBackground": "#00000035",
"statusBarItem.hoverBackground": "#00000035",
"statusBarItem.prominentBackground": "#00000035",
"statusBarItem.prominentHoverBackground": "#00000035",
"editor.lineHighlightBackground": "#00000000",
"editorGroupHeader.noTabsBackground": "#00ffaa70",
"editorGroupHeader.border": "#aeff00",
"editorGroup.dropBackground": "#aeff00",
"titleBar.activeBackground": "#2a2a2a",
"menu.background": "#1e1d1d",
"menu.selectionBackground": "#aeff0070",
"scrollbarSlider.background": "#00ffaa70"
},
"activityBar.background": "#283109",
"titleBar.activeBackground": "#38440C",
"titleBar.activeForeground": "#F8FCEC"
}
}
20 changes: 20 additions & 0 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
{
"version": "2.0.0",
"tasks": [
{
"type": "npm",
"script": "watch",
"problemMatcher": "$tsc-watch",
"isBackground": true,
"presentation": {
"reveal": "never"
},
"group": {
"kind": "build",
"isDefault": true
}
}
]
}
11 changes: 11 additions & 0 deletions .vscodeignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.vscode/**
.vscode-test/**
src/**
.gitignore
.yarnrc
vsc-extension-quickstart.md
**/tsconfig.json
**/eslint.config.mjs
**/*.map
**/*.ts
**/.vscode-test.*
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Change Log

All notable changes to this project will be documented in this file.
## [Unreleased]

- Initial release
89 changes: 89 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# VS-Notes

## Developer Information

### Developer

- **Name**: Dominic Minnich
- **GitHub**: [GitHub Profile URL](https://github.com/DomMinnich)

**VS-Notes** is a simple and intuitive note-taking extension for Visual Studio Code. It allows users to create, manage, and organize notes directly within the editor. Perfect for developers who need to jot down quick ideas, to-do lists, or project-related information without leaving the VS Code environment. Notes are stored globally, so they can be accessed across all projects in your VS Code environment.

## Features

- **Create Notes**: Quickly create new `.txt` notes by clicking the "New Note" button.
- **Manage Notes**: View, rename, and delete notes directly from the activity bar.
- **Quick Access**: All notes are accessible from the activity bar, making it easy to switch between your code and notes.
- **Persistent Notes**: Notes are stored globally, so they can be accessed across all projects in your VS Code environment.
- **Rename and Delete**: Click on any note to rename or delete it.

### Commands

- **New Note**: Ctr + Shift + P to bring up the command palette and type "Create A New Note" to create a new note.

### Screenshots

Here's how the VS-Notes extension looks in action:

#### Activity Bar Panel

![VS-Notes in Activity Bar](images/activityBar.png)

#### Creating a New Note

![Create New Note](images/createNote.png)

#### Managing Notes (Rename and Delete)

![Managing Notes](images/actions.gif)

> Tip: You can customize the look and behavior of the extension through VS Code's settings.
## Requirements

VS-Notes does not have any external dependencies. It works out of the box in any VS Code environment, but you should be using VS Code version `1.60.0` or higher to ensure compatibility.

## Extension Settings

VS-Notes does not currently add any additional settings, but future releases may include more customizable options such as note templates or custom note directories.

## How to Use

1. **Opening the Notes Panel**: Click the VS-Notes icon in the activity bar to open the notes panel.
2. **Creating a New Note**: Click on the "New Note" button, and you'll be prompted to give the note a name.
3. **Viewing Notes**: Click on any note from the list to open it in a new tab.
4. **Renaming Notes**: Right-click on any note and choose the "Rename" option. You will be prompted to enter a new name for the note (the `.txt` extension is handled automatically).
5. **Deleting Notes**: Right-click on any note and select "Delete" to remove it from your list.

## Known Issues

- **No Multi-File Support**: Currently, each note is created as an individual `.txt` file. Future updates may include support for other file types.
- **Cross-System Compatibility**: Notes are stored in the global storage location of VS Code, meaning they're specific to the VS Code environment and not synced across different machines automatically.

If you encounter any bugs or have feature requests, feel free to report them via the GitHub Issues page

## Release Notes

### 1.0.0

- Initial release of VS-Notes.
- Features: Create, rename, and delete notes from the activity bar.

## Following extension guidelines

Ensure that you've read through the extension guidelines and follow the best practices for creating your extension.

- [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)

## Feedback and Contributions

If you’d like to contribute or provide feedback, feel free to open a pull request or issue on the GitHub repository.

---

## For more information

- [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
- [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)

**Enjoy using VS-Notes!**
28 changes: 28 additions & 0 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import typescriptEslint from "@typescript-eslint/eslint-plugin";
import tsParser from "@typescript-eslint/parser";

export default [{
files: ["**/*.ts"],
}, {
plugins: {
"@typescript-eslint": typescriptEslint,
},

languageOptions: {
parser: tsParser,
ecmaVersion: 2022,
sourceType: "module",
},

rules: {
"@typescript-eslint/naming-convention": ["warn", {
selector: "import",
format: ["camelCase", "PascalCase"],
}],

curly: "warn",
eqeqeq: "warn",
"no-throw-literal": "warn",
semi: "warn",
},
}];
Binary file added images/actions.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/activityBar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/createNote.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 2f0c909

Please sign in to comment.