Rename project to straw

.github/workflows/release.yml

@@ -59,11 +59,11 @@ jobs:
           commit: master
           allowUpdates: true
 
-      - name: Create the issue html index.html
-        run: ./_build/${{ matrix.os }}.exe html > ./issue/index.html
+      - name: Create the straw html index.html
+        run: ./_build/${{ matrix.os }}.exe html > ./straw/index.html
 
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./issue
+          publish_dir: ./straw

.gitignore

@@ -1,4 +1,4 @@
 _build/
-issue/index.html
-issue/template.html
-lib/issue_lib/resources/template.html
+straw/index.html
+straw/template.html
+lib/straw/resources/template.html

README.md

@@ -0,0 +1,19 @@
+# Straw 🌾
+
+Simple issues/notes using markdown files and a thin CLI wrapper.
+
+## Reasoning
+
+Because you want something portable and simpel.
+
+## Usage
+
+`straw --help`
+
+## Releases
+
+[https://github.com/bas080/straw/releases][releases]
+
+> You can get a binary there or build your own.
+
+[releases]:https://github.com/bas080/straw/releases

bin/dune

@@ -5,10 +5,10 @@
    (:standard -O2 -ccopt -static -ccopt -s))))
 
 (executable
- (public_name issue)
+ (public_name straw)
  (name main)
  (modes native)
  (libraries
-  issue_lib
+  straw
   ;; CLI argument parsing
   cmdliner))

bin/main.ml

@@ -1,5 +1,5 @@
 open Cmdliner
-open Issue_lib.Cli
+open Straw.Cli
 
 let working_on_it cmd = Printf.eprintf "Executing '%s' subcommand\n" cmd
 
@@ -11,32 +11,32 @@ let init_cmd =
 
 let list_cmd =
   Cmd.v
-    (Cmd.info "list" ~doc:"List the current issues")
+    (Cmd.info "list" ~doc:"List the current issue/note")
     Term.(const list $ const ())
 
 let open_cmd =
   Cmd.v
-    (Cmd.info "open" ~doc:"Open a new issue")
-    Term.(const open_issue $ const ())
+    (Cmd.info "open" ~doc:"Open a new issue/note")
+    Term.(const open_item $ const ())
 
 let dir_cmd =
   Cmd.v
-    (Cmd.info "dir" ~doc:"Show the current issue directory")
-    Term.(const (fun () -> issue_dir () |> Issue_lib.Path.to_string |> print_endline) $ const ())
+    (Cmd.info "dir" ~doc:"Show the current straw directory")
+    Term.(const (fun () -> straw_dir () |> Straw.Path.to_string |> print_endline) $ const ())
 
 let search_cmd =
   Cmd.v
-    (Cmd.info "search" ~doc:"Keyword search through issues")
+    (Cmd.info "search" ~doc:"Keyword search through issues/notes")
     Term.(const working_on_it $ const "search")
 
 let status_cmd =
   Cmd.v
-    (Cmd.info "status" ~doc:"Show the number of files in each issue category")
+    (Cmd.info "status" ~doc:"Show the number of files in each category")
     Term.(const status $ const ())
 
 let html_cmd =
   Cmd.v
-    (Cmd.info "html" ~doc:"Print issues as HTML")
+    (Cmd.info "html" ~doc:"Print issues/notes as HTML")
     Term.(const html $ const ())
 
 let subcommands = [
@@ -50,10 +50,10 @@ let subcommands = [
 ]
 
 let root_cmd =
-  let doc = "Issue management from the CLI" in
+  let doc = "Issue management and note keeping from the CLI" in
   let man = [`S "BUGS"; `P "Email bug reports to <bassimhuis@gmail.com>."] in
   let sdocs = Manpage.s_common_options in
-  let info = Cmd.info "issue" ~version:"%%VERSION%%" ~doc ~man ~sdocs in
+  let info = Cmd.info "straw" ~version:"%%VERSION%%" ~doc ~man ~sdocs in
   (* show help when no subcommand is provided *)
   let default = Term.(ret (const (`Help (`Pager, None)))) in
   Cmd.group ~default info subcommands

browser/package.json

@@ -1,10 +1,10 @@
 {
-  "name": "issue",
+  "name": "straw",
   "version": "0.0.0",
-  "description": "Browser code for fancy issue features",
+  "description": "Frontend for the straw projects",
   "scripts": {
     "build": "npx parcel build template.html",
-    "postbuild": "cp dist/template.html ../lib/issue_lib/resources/template.html",
+    "postbuild": "cp dist/template.html ../lib/straw/resources/template.html",
     "dev": "npx parcel serve template.html",
     "lint": "npx standard",
     "lintfix": "npx prettier --write . ; npx standard --fix",

browser/template.html

@@ -1,7 +1,7 @@
 <!doctype html>
 <html lang="en">
   <head>
-    <title>Issue / Issues</title>
+    <title>Straw</title>
 
     <link
       rel="icon"
@@ -615,26 +615,26 @@
 
           <dt><code>/directory</code></dt>
           <dd>
-            Filters issues that belong to a specific directory or iteration.
+            Filters items that belong to a specific directory or iteration.
           </dd>
 
           <dt><code>#hashtag</code></dt>
-          <dd>Identifies issues that include a specific hashtag.</dd>
+          <dd>Identifies items that include a specific hashtag.</dd>
 
           <dt><code>@mention</code></dt>
-          <dd>Finds issues that mention a specific person.</dd>
+          <dd>Finds items that mention a specific person.</dd>
 
           <dt><code>or</code></dt>
           <dd>
             Introduces a logical OR operator to stop the previous query and
-            define another one for finding more issues.
+            define another one for finding more items.
           </dd>
         </dl>
       </details>
       <p id="issue-search-count"></p>
 
       <div class="issue-issues">
-        <!--issues-->
+        <!--items-->
       </div>
     </main>
 

dune-project

@@ -1,7 +1,7 @@
 (lang dune 3.0)
 
 (package
- (name issue)
+ (name straw)
  (depends
   (ocaml (>= "5.1.1"))
   (fpath (>= "0.7.3"))