zaptst / zap

A streamable structured interface for real time reporting of developer tools.
MIT License
120 stars 1 forks source link

Kinds #7

Closed jamiebuilds closed 6 years ago

jamiebuilds commented 6 years ago

Right now there are three "kinds" of events in ZAP:

  • "suite" A group of tests or other suites
  • "test" An individual test case containing assertions
  • "assertion" An individual bit of logic that passes or fails.

These names seem pretty test-framework centric and don't clearly map to other types of tools like linters or type checkers.

I want to play around with different ideas for names, like the following:

Where a testing framework might look like this:

- item: Test
    - check: Assertion
- group: Suite
  - item: Test
    - check: Assertion
    - check: Assertion
  - item: Test
    - check: Assertion
  - group: Nested Suite
    - item: Test
      - check: Assertion
      - check: Assertion
      - check: Assertion

And a linter might look like this:

- group: File
  - check: Lint Error
  - check: Lint Error
  - check: Lint Error
- group: File
  - check: Lint Error
  - check: Lint Error
  - check: Lint Error

And a type checker might look like this:

- check: Type Error
- check: Type Error
- check: Type Error
- check: Type Error
- check: Type Error
- check: Type Error

There's also the potential that there is actually no need for a "kind" and the tree structure alone is enough.

sindresorhus commented 6 years ago

👍 I like the improved naming. Can't really think of anything better.