Setup: notewolfy Project

notewolfy is a project that allows you to take organized notes in form
of Markdown files and let them edit via Vim. notewolfy builds uppon the
cyclecmd project and is a console application.

Signed-off-by: Raphael Skuza <[email protected]>

.gitignore

@@ -0,0 +1,5 @@
+# synmake
+config.yaml
+
+# Go
+coverage*

CHANGELOG/v0.1.0.md

@@ -0,0 +1,8 @@
+# v0.1.0
+## Features
+- Note taking with Vim and Markdown
+- Available Commands: create workspace, create node, create md, delete workspace, delete node, delete md, edit, open, version, help, ls, ls ws, goto, goback
+- State is stored in metadata file in your home directory as .notewolfy
+## Bug Fixes
+## Notes
+- When the user presses any of the arrow keys, notewolfy quits, this will be fixed in later versions

LICENSE

@@ -0,0 +1,190 @@
+   Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright [2024] [RaphSku]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

Makefile

@@ -0,0 +1,49 @@
+.PHONY: default
+default: help
+
+.PHONY: start
+## Run the CLI tool
+start: 
+	@go run main.go
+
+.PHONY: unit-tests
+## Run Unit Tests
+unit-tests:
+	go test -coverprofile=coverage_unit.out -cover ./... -tags unit_test
+	go tool cover -html coverage_unit.out -o coverage_unit.html
+
+.PHONY: integration-tests
+## Run Integration Tests
+integration-tests:
+	go test -coverprofile=coverage_int.out -cover ./... -tags integration_test
+	go tool cover -html coverage_int.out -o coverage_int.html
+
+.PHONY: e2e-tests
+## Run E2E Tests
+e2e-tests:
+	go test -coverprofile=coverage_e2e.out -cover ./... -tags e2e_test
+	go tool cover -html coverage_e2e.out -o coverage_e2e.html
+
+.PHONY: run-test-suite
+## Run Complete Test Suite
+run-test-suite: unit-tests integration-tests e2e-tests
+
+help:
+	@echo "----------------------------------"
+	@echo "Welcome to make! Enjoy the flight."
+	@echo "Makefile - make [\033[38;5;154mtarget\033[0m]"
+	@echo "----------------------------------"
+	@echo
+	@echo "Targets:"
+	@awk '/^[a-zA-z\-_0-9%:\\]+/ { \
+		description = match(descriptionLine, /^## (.*)/); \
+		if (description) { \
+			target = $$1; \
+			description = substr(descriptionLine, RSTART + 3, RLENGTH); \
+			gsub("\\\\", "", target); \
+			gsub(":+$$", "", target); \
+			printf "    \033[38;5;154m%-25s\033[0m %s\n", target, description; \
+		} \
+	} \
+	{ descriptionLine = $$0 }' $(MAKEFILE_LIST)
+	@printf "\n"

README.md

@@ -0,0 +1,89 @@
+# notewolfy
+## Description
+notewolfy simplifies note-taking and organization into a straightforward tree-like structure. Currently, notewolfy supports note-taking through Markdown files via Vim. If you're unfamiliar with Vim, I recommend learning it before using notewolfy. Take notes of something noteworthy.
+
+## How to get it
+You can get notewolfy with the following command:
+```bash
+go install github.com/RaphSku/notewolfy@latest
+```
+
+## How to use it
+notewolfy is a console application, so open your terminal and type in:
+```bash
+notewolfy
+```
+You will see a prompt where you can start typing:
+```bash
+>>> create workspace example ~/example
+```
+This will create a new workspace for you named `example` at the path `~/example`. Before we start taking notes, consider organizing your workspace further. For instance, if you're researching something, you might want to create a `research` node within your workspace.
+```bash
+>>> create node research
+```
+Now, move to your new node with
+```bash
+>>> goto research
+```
+And let us create a Markdown file.
+```bash
+>>> create md research_topic_a
+```
+Edit your new Markdown file and write something into it.
+```bash
+>>> edit research_topic_a
+```
+You will see that Vim opens and will let you edit your Markdown file. Furthermore, you have seen how to navigate forward but how do we get back? Well, just go back.
+```bash
+>>> goback
+```
+By the way, at any time you can use
+```bash
+>>> ls
+```
+to see information about the current node you are on and which Markdown files reside there and you can use
+```bash
+>>> ls ws
+```
+to see information about all your workspaces, namely the name and the path where they reside. This is useful if you forget the path to your workspace.
+If one workspace does not suffice, just create another workspace
+```bash
+>>> create workspace example2 ~/example2
+```
+You will not need to switch to the new workspace since this is done automatically. But if you want to open a particular workspace, you can simply use
+```bash
+>>> open example2
+```
+Once you are finished, you can close notewolfy by pressing either keys: "Esc", "Ctrl+C" or type in the following commands: "quit" or "exit".
+
+If you want to delete Markdown files, you can do this with
+```bash
+>>> delete md <markdownFileName>
+```
+, leave the extension .md out when you specify the name. You can only delete Markdown files on the node that you are currently on. You can also delete a node with
+```bash
+>>> delete node <nodeName>
+```
+but you need to go to the parent node to delete the child node. If you have deleted all Markdown files and nodes, you can also delete the workspace.
+```bash
+>>> delete workspace <workspaceName>
+```
+A bulk delete is currently not supported but if you want to delete the whole workspace without going over every node and Markdown file, you can simply delete it via the file explorer or terminal. You also need to remove the workspace metadata in the `.notewolfy` metadata file that was created in your home directory. It is JSON encoded, so just remove the workspace entry under workspaces.
+
+If you need help with a command, try to use
+```bash
+help create workspace
+```
+
+If you want to see the version of notewolfy that you are using, just use the following command
+```bash
+notewolfy version
+```
+or inside of notewolfy
+```bash
+>>> version
+```
+there is also the version command available.
+
+## Supported OS
+Only UNIX operating systems are supported. Sorry, no Windows for the time being.

cmd/root.go

@@ -0,0 +1,49 @@
+package cmd
+
+import (
+	"context"
+	"os"
+
+	"github.com/RaphSku/notewolfy/cmd/version"
+	"github.com/RaphSku/notewolfy/internal/console"
+	"github.com/spf13/cobra"
+	"go.uber.org/zap"
+)
+
+type CLI struct {
+	ctx    context.Context
+	logger *zap.Logger
+
+	rootCmd *cobra.Command
+}
+
+func NewCLI(ctx context.Context, logger *zap.Logger) *CLI {
+	rootCmd := &cobra.Command{
+		Use:   "notewolfy",
+		Short: "notewolfy a minimalistic note taking console application",
+		Long:  `notewolfy is a minimalistic note taking console application that allows you to organize and manage your markdown notes`,
+		Run: func(cmd *cobra.Command, args []string) {
+			console.StartConsoleApplication(ctx)
+		},
+	}
+
+	rootCmd.CompletionOptions.DisableDefaultCmd = true
+
+	return &CLI{
+		ctx:     ctx,
+		logger:  logger,
+		rootCmd: rootCmd,
+	}
+}
+
+func (cli *CLI) AddSubCommands() {
+	versionCmd := version.NewVersionCommand()
+	cli.rootCmd.AddCommand(versionCmd)
+}
+
+func (cli *CLI) Execute() {
+	if err := cli.rootCmd.Execute(); err != nil {
+		cli.logger.Info("CLI failed to run", zap.Error(err))
+		os.Exit(1)
+	}
+}