• [x] (1) In the help for ls -p it says "search FIELDS using pearl regexp SEARCH." when it should say "search FIELDS rust regexp."
• [x] (2) Inconsistent capitalization, "if set no output will be printed" vs "Prints help information."
• [ ] (3) Imperative vs declarative in messages: "Prints" or "sets" vs "start" or "delay"
• [x] (4) Some messages are too long for a 80 character terminal:

      -v             sets the level of verbosity, use multiple (up to 3) to increa
  se
  

• [x] (5) Some unnecessarily terse primary descriptions, e.g. there's no good reason to abbreviate "current directory" or "current folder" in

  art-init 
  initialize the repository in the cwd
  

• [X] ~(6) Should the descriptions be formatted like man pages?~ No

  art-init - Initialize the repository in the current directory
  

• [x] (7) The top level descriptions should probably be capitalized.
• [X] ~(8) I think that indenting the long versions of flags when there's no short version looks weird, but I can probably be persuaded to the contrary.~ No
• [x] (9) Some hanging indents are strangely deep:

      -w             If a file's formatting is different from art fmt,
                                         overwrite it with art fmt's vesion
  

• [ ] (10) Should "will be *deactivated* instead of activated" be formatted like this?
• [x] (11) Does art-export need "(only html currently)" in its primary description?
• [X] ~(12) art help -h produces an error.~ It should produce an error, it is invalid
• [x] (13) Clarify the > == >100 explanation.
• [x] (14) The --work-tree <work-tree> causes indentation to be deeper than it needs to be, changing the value name to something like --work-tree <PATH> would reduce rightward drift.
• [x] (15) Enable colored help messages?
• [x] (16) Should we make all of the value names all caps like the manual ones are? Currently we have -c <completed> mixed with -p <FIELDS>.

I am interested in relicensing this project as dual MIT + Apache 2.0. I think the only thing required to do so is approval from those who have contributed. The following is a list of all contributors, if you could assent your approval that would be extremely helpful.

If you have any comments or concerns, please voice them!

• [x] @jmcquown
• [x] @vitiral
• [x] @packapotatoes
• [x] @porglezomp
• [x] @chrisvittal
• [x] @rubdos
• [x] @matthewjberger
• [x] @einsweniger
• [x] @fstephany
• [x] @jplatte
• [x] @imp
• [x] @hdhoang
• [x] @llogiq

Sorry to everyone for the inconvenience and thank you for your contributions!

This change is mainly prompted because I would like to embed graphiz DOT language (which represents node graphs, see #158), but its license is Eclipse and cannot work with GPL.

They are working on changing it to Eclipse 2.0 (which should be simple), but the "GPL compatibility clause" is not possible to add for legacy projects, and would basically involve a complete re-licensing effort on their part as well.

Edit:

I checked and gerd contributed a typo fix for docs and TheAustinJones contributed code that has since been deleted. Since they haven't responded and their response isn't necessary I am removing them from the list.

• ~~@gerd2002~~
• ~~@TheAustinJones~~

Since ls -l indented the text section by 4 characters, requirements written 80 characters wide sometimes exhibited ugly wrapping. By removing the indentation, 80 character wide messages look good.

This also adds an extra newline at the end of the ls -l text section in order to more easily distinguish between each entry.

This is to move the documentation off of the wiki and make Simple Quality book the primary user guide. After this is merged the Wiki will be ONLY for contributor guides (other guides will be removed)

Fixes:

• fix #73
• fix #74
• fix #69

This moves the docs to the docs/ folder and adds:

• CheatSheet.md: for those already familiar with artifact or need a reference
• QuickGuide.md: quick overview for those who want to see what the tool is capable of or who have experience tracking requirements.

I've downloaded the release tarball from here, extracted it into ~/.local/bin (which is in $PATH) and then tried to run it on an Ubuntu 18.10 (Cosmic Cuttlefish) development system.

It fails in an extremely odd way.

> ~/.local/bin/art --help
zsh: no such file or directory: /home/chris/.local/bin/art

Huh.

 > ldd ~/.local/bin/art 
	linux-vdso.so.1 (0x00007ffe0bdd3000)
	libdl.so.2 => /lib/x86_64-linux-gnu/libdl.so.2 (0x00007fb17762f000)
	librt.so.1 => /lib/x86_64-linux-gnu/librt.so.1 (0x00007fb177625000)
	libpthread.so.0 => /lib/x86_64-linux-gnu/libpthread.so.0 (0x00007fb177604000)
	libgcc_s.so.1 => /lib/x86_64-linux-gnu/libgcc_s.so.1 (0x00007fb1775ea000)
	libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007fb177400000)
	/nix/store/2kcrj1ksd2a14bm5sky182fv2xwfhfap-glibc-2.26-131/lib/ld-linux-x86-64.so.2 => /lib64/ld-linux-x86-64.so.2 (0x00007fb1793bb000)
	libm.so.6 => /lib/x86_64-linux-gnu/libm.so.6 (0x00007fb177273000)

Hm, maybe the oddly stored location for ld-linux is confusing it?

>  /lib64/ld-linux-x86-64.so.2 ~/.local/bin/art  
thread 'main' panicked at 'not yet implemented: sub: ', src/lib.rs:83:21
note: Run with `RUST_BACKTRACE=1` for a backtrace.

Huh! Well, that at least loads. I wonder what the backtrace is?

> RUST_BACKTRACE=1 /lib64/ld-linux-x86-64.so.2 ~/.local/bin/art 
thread 'main' panicked at 'not yet implemented: sub: ', src/lib.rs:83:21
stack backtrace:
   0: <unknown>
   1: <unknown>
   2: <unknown>
   3: <unknown>
   4: <unknown>
   5: <unknown>
   6: <unknown>
   7: <unknown>
   8: <unknown>
   9: <unknown>
  10: <unknown>
  11: <unknown>
  12: <unknown>
  13: <unknown>
  14: __libc_start_main
  15: <unknown>

Heh. Not very enlightening!

Other rust projects (notably, my own, cargo, and ripgrep) build and work fine on this system; I wonder what's odd with the art binary?

I would like to leverage svgbob to be able to support svg diagrams.

Basic design

The svg code block will render as an svg diagram. I.e.

\`\`\`svg
    -o----o---
          |                    .--> D
           \                  /
A -> B -> C -----------------*---> .
            \         ^  ^ ^  \
             B -> C _/  / /    '--> D
 *----->           \   / /
                    *
\`\`\`

The backend/static site would search for these blocks and add a rendered_svg field onto Project which would be a HashMap<ArtName, Vec<SVG>> containing the indexed svg images in the specified artifact's text.

Future Improvements

In the future there could be a RenderSvgs API call to dynamically render a list of raw svgs so that svg can be rendered while editing (without needing to save).

This issue is for tracking the development of the test tracking tool. Please link external documents and have general conversation in this thread.

This is in the design docs as:

http://vitiral.github.io/artifact/#artifacts/REQ-TRACKER

I just discovered markdown links don't render in list view.

To be honest I think it improves the readability of the overall table - to see no links in the text.

art serve is mentioned several times in README.md, e.g. here.

art serve

Encountered Error:

error: Found argument 'serve' which wasn't expected, or isn't valid in this context

USAGE:
    art [FLAGS] [OPTIONS] <SUBCOMMAND>

For more information try --help

art -h

artifact 1.0.0
https://github.com/vitiral/artifact
The requirements tracking tool made for developers. Call `art tutorial` for a tutorial

USAGE:
    art [FLAGS] [OPTIONS] <SUBCOMMAND>

FLAGS:
    -v               Verbose, pass up to 3 times to increase the level
    -q, --quiet      If set no output will be printed
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
        --work-tree <PATH>    Use a different working tree instead of cwd

SUBCOMMANDS:
    tutorial    Start the interactive tutorial
    init        Initialize an artifact repository in the current directory
    ls          List artifacts according to various parameters
    check       Check for any errors in the project
    fmt         Format your design documents
    export      Export artifacts as static files
    update      Update to a different version (default newest)
    help        Prints this message or the help of the given subcommand(s)

This is a followup to #168. Enough changes were made for me to warrant creating a new PR.

I implemented this as a tools subcommand after my attempt to make it an option of export had the unfortunate side effect of needing to have an artifact project initialized in order to use commands that did not need to have an associated project.

I'm on macOS 10.13.5, and I'm building artifact from source since there's no macOS binary (yet). Building from source gives me a number of errors, some of which I can fix.

Edit: I should add that I'm using the source code from the release page.

Missing cargo-web dependency

The first seems to be that cargo-web is required:

--- stdout
Build Script Started
Building artifact-frontend

--- stderr
error: no such subcommand: `web`

	Did you mean `new`?

thread 'main' panicked at 'artifact-frontend failed to build', build.rs:56:5
note: Run with `RUST_BACKTRACE=1` for a backtrace.

I installed cargo-web separately via cargo install cargo-web and things progressed.

Bug in stdweb < 0.4.8

This is a known issue (see here), and has already been fixed in stdweb. All I needed to do was update Cargo.toml for artifact-frontend.

Incorrect paths used during build

I started running cargo check to speed things up, and I got this error message:

artifact-2.0.0!$ RUST_BACKTRACE=1 cargo check                                                                                  2m4s ~/Projects/artifact-2.0.0
   Compiling artifact-app v2.0.0 (file:///Users/zmitchell/Projects/artifact-2.0.0)
error: failed to run custom build command for `artifact-app v2.0.0 (file:///Users/zmitchell/Projects/artifact-2.0.0)`
process didn't exit successfully: `/Users/zmitchell/Projects/artifact-2.0.0/target/debug/build/artifact-app-7def9eec474743ad/build-script-build` (exit code: 101)
--- stdout
Build Script Started
Building artifact-frontend
Building the book

--- stderr
    Finished release [optimized] target(s) in 0.16s
    Garbage collecting "artifact-frontend.wasm"...
    Processing "artifact-frontend.wasm"...
    Finished processing of "artifact-frontend.wasm"!
The `artifact-frontend` was deployed to "/Users/zmitchell/Projects/artifact-2.0.0/artifact-frontend/target/deploy"!
thread 'main' panicked at 'called `Result::unwrap()` on an `Err` value: Os { code: 2, kind: NotFound, message: "No such file or directory" }', libcore/result.rs:945:5
stack backtrace:
   0: std::sys::unix::backtrace::tracing::imp::unwind_backtrace
             at libstd/sys/unix/backtrace/tracing/gcc_s.rs:49
   1: std::sys_common::backtrace::print
             at libstd/sys_common/backtrace.rs:71
             at libstd/sys_common/backtrace.rs:59
   2: std::panicking::default_hook::{{closure}}
             at libstd/panicking.rs:211
   3: std::panicking::default_hook
             at libstd/panicking.rs:227
   4: <std::panicking::begin_panic::PanicPayload<A> as core::panic::BoxMeUp>::get
             at libstd/panicking.rs:475
   5: std::panicking::continue_panic_fmt
             at libstd/panicking.rs:390
   6: std::panicking::try::do_call
             at libstd/panicking.rs:325
   7: core::ptr::drop_in_place
             at libcore/panicking.rs:77
   8: core::alloc::Layout::align
             at /Users/travis/build/rust-lang/rust/src/libcore/macros.rs:26
   9: <core::result::Result<T, E>>::unwrap
             at /Users/travis/build/rust-lang/rust/src/libcore/result.rs:782
  10: build_script_build::build_mdbook
             at ./build.rs:23
  11: build_script_build::main
             at ./build.rs:9
  12: std::rt::lang_start::{{closure}}
             at /Users/travis/build/rust-lang/rust/src/libstd/rt.rs:74
  13: std::panicking::try::do_call
             at libstd/rt.rs:59
             at libstd/panicking.rs:310
  14: panic_unwind::dwarf::eh::read_encoded_pointer
             at libpanic_unwind/lib.rs:106
  15: <std::sync::mutex::Mutex<T>>::new
             at libstd/panicking.rs:289
             at libstd/panic.rs:392
             at libstd/rt.rs:58
  16: std::rt::lang_start
             at /Users/travis/build/rust-lang/rust/src/libstd/rt.rs:74
  17: <build_script_build::FRONTEND_DEPLOY as core::ops::deref::Deref>::deref

As you can see, the panic is caused by unwrapping an error which is caused by a file/directory not being found. If you look at the backtrace, you'll see that the path /Users/travis/... is being used. I suspect that some CI stuff is leaking through to user installs, but I did verify that there's no travis user on my computer using dscl . list /Users | grep -v '^_'. I'm not sure where the travis part is leaking through though.

Note: this project, and the python re-write, should now be considered abandoned. Please use it as you see fit.

https://docs.github.com/en/repositories/archiving-a-github-repository/archiving-repositories

The link to the flash card challenge under "Starting Your Project" is: http://wiki.openhatch.org/Flash_card_challenge

And it should be: https://wiki.openhatch.org/wiki/Flash_card_challenge

I have done a rewrite (and reimagining) of artifact. I wrote it in python. The rewrite is NOT compatible with this version, think of it as 3.0 beta.

You can view the rewrite here: https://github.com/vitiral/artifact_py

• Usage of where on windows rather than which
• Slicing of Extended-Length Paths using regex on windows as a workaround to std::process::Command.current_dir not accepting them

Hello,

I'm interested in using Artifact for a project, but I'm developing on Windows. I downloaded the source and have attempted to compile - both mdbook and cargo-web are installed, but even with both of them in place, any post-2.0 release of artifact fails to build with the following error:

   Compiling artifact_lib v0.1.0 (C:\Users\Josh\Documents\GitHub\artifact\artifact-lib)
error: failed to run custom build command for `artifact-app v2.1.0 (C:\Users\Josh\Documents\GitHub\artifact\artifact-app)`

Caused by:
  process didn't exit successfully: `C:\Users\Josh\Documents\GitHub\artifact\target\release\build\artifact-app-725f2e4ceebe7093\build-script-build` (exit code: 101)
--- stdout
Build Script Started
Checking dependencies

--- stderr
thread 'main' panicked at 'which/where doesn't exist: Os { code: 2, kind: NotFound, message: "The system cannot find the file specified." }', src\libcore\result.rs:999:5
note: Run with `RUST_BACKTRACE=1` environment variable to display a backtrace.

warning: build failed, waiting for other jobs to finish...
error: build failed

The backtrace seemed pretty long and unhelpful. The most prominent note in it was several occurences of unresolved external symbol emscripten_asm_const_int. If someone is willing to point me in the right direction, I'd love to do what needs to get done to get this working.

I tried to cargo install artifact-app in order to update artifact only to realize it tried to build v1.0.1 (which failed btw), and that the artifact crates available were super old. How come? Maybe you should just drop the cargo install from the tutorial.

I then realized that I originally just installed the binaries.

While I'm there, latest release v2.1.5 panics when I just invoke art with no argument, I guess it should probably display some help info.