Skip to content

stanleygomes/codex-notes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

333 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ—’οΈ Codex Notes

Build License

Codex Notes is a powerful plugin for managing notes directly within your IDE. Keep your thoughts, code snippets, and documentation organized without leaving your development environment.

  • Create, edit, delete, rename, and search notes with full markdown support
  • Favorite and assign colors to notes for quick identification and access
  • Sort notes by title, creation date, or favorite status
  • Duplicate notes for easy replication
  • Import notes from external files
  • Export notes to external files
  • Open note file locations in the file system
  • Filter notes by favorites
  • Create notes from selected text in the editor
  • Integrated search via IntelliJ's Search Everywhere
  • Customizable settings for file extension, notes directory, export options, import options, and folder access

VSCode

screenshot

Jetbrains

screenshot

🌐 Plugin Marketplace Links

Platform Link
JetBrains JetBrains Marketplace
VS Code Visual Studio Marketplace
Cursor Cursor Marketplace
Open VSX Open VSX Registry

πŸ“‹ Table of Contents

πŸš€ Usage

Opening the Tool Window

  • Click on the Codex Notes icon in the left sidebar of your editor;
  • Or use the menu: View β†’ Tool Windows β†’ Codex Notes on jetbrains IDEs;

⌨️ Keyboard Shortcuts

Action Shortcut
Open note Double-click or Enter
Rename note F2
Toggle favorite F
Delete note Delete
Duplicate note Ctrl+D
Export note Ctrl+E
Open location Ctrl+Shift+E

πŸ› οΈ Development

For jetbrains plugin

Requirements

  • Java 17+
  • IntelliJ IDEA 2025.2.5+
  • Gradle 9.3.1+

Available Commands

Command Description
make help Shows available commands in the Makefile
make build Compiles the project
make build-plugin Compiles the IntelliJ plugin
make verify-plugin Verifies plugin compatibility
make test Runs tests
make test-coverage Runs tests with coverage report
make codecov Uploads coverage report to Codecov
make inspections Runs code inspections with Qodana
make run Launches IntelliJ with the plugin for testing
make update-version Updates version based on conventional commits
make check Runs code style checks with Ktlint
make format Automatically formats code with Ktlint

Coverage reports are generated in build/reports/jacoco/test/html/index.html and are generated by Kover Gradle plugin.

For vscode extension

Requirements

  • Node.js 18+
  • VS Code 1.85.0+

Available Commands

Command Description
yarn install Installs dependencies
yarn build Compiles the extension
yarn lint Runs ESLint checks
yarn test Runs extension tests
yarn package Packages the extension for distribution
yarn publish Publishes the extension to VS Code Marketplace
yarn ovsx:publish Publishes to OpenVSX Registry

Coverage reports are generated in coverage/ and use the nyc tool.

πŸš€ CI/CD

This project uses GitHub Actions for continuous integration and deployment. The following workflows are configured:

Build Workflow (build.yml)

  • Trigger: Push to master branch or pull requests
  • Actions:
    • Validates conventional commits
    • Builds and validates the VS Code extension (lint, test, package)
    • Builds the JetBrains plugin
    • Runs JetBrains unit tests and uploads coverage to Codecov
    • Executes Qodana code inspections
    • Runs IntelliJ Plugin Verifier

Release Workflow (release.yml)

  • Trigger: Manual dispatch (workflow_dispatch)
  • Inputs:
    • target β€” which plugin to release: both (default), jetbrains, or vscode
    • publish_jetbrains β€” boolean, default true
    • publish_vscode β€” boolean, default true
    • create_github_release β€” boolean, default true
  • Version auto-detection: The workflow reads commits since the last v* tag and applies semantic versioning rules (breaking change β†’ major, feat: β†’ minor, everything else β†’ patch).
  • Jobs:
    1. prepare_release β€” auto-calculates versions, bumps files, updates changelogs, opens a PR targeting master, and creates the v<version> tag
    2. publish_jetbrains (conditional) β€” builds, signs, and publishes to JetBrains Marketplace
    3. publish_vscode (conditional) β€” packages and publishes to Visual Studio Marketplace and OpenVSX
    4. create_release (conditional) β€” creates separate GitHub Releases per plugin and attaches built artifacts

Deploy Landpage Workflow (deploy-landpage.yml)

  • Trigger: Push to master affecting landpage/**, or manual dispatch
  • Actions:
    • Builds and deploys the landing page to Vercel

πŸ“¦ How to Release

  1. Go to Actions β†’ Release in the GitHub repository.
  2. Click Run workflow and choose:
    • target: both to release all plugins, or jetbrains / vscode to release a single one
    • Toggle publish_jetbrains, publish_vscode, and create_github_release as needed.
  3. The workflow will automatically:
    • Detect the new version from commits since the last release tag using semantic versioning.
    • Bump versions in jetbrains/gradle.properties and/or vscode/package.json.
    • Update the respective CHANGELOG.md with commit entries.
    • Open a release PR with the generated changes targeting master.
    • Create the v<version> git tag.
    • Publish to the selected marketplaces.
    • Create separate GitHub Releases per plugin with built artifacts.

🀝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

πŸ“œ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ”— Links

For jetbrains Plugin


Made with πŸ”₯ by NazarethLabs

About

πŸ—’οΈ A powerful plugin for managing notes within your IDE (vscode, IntelijIdea, Android studio)

Topics

Resources

License

Stars

Watchers

Forks

Contributors