Skip to content

Should tests/demos/docs be included in the NPM published artifacts? #344

@klebba

Description

@klebba

Reasons for:

  • Demos run without compilation; developers can consult the demos alongside their app code (/lib/@netflix/x-element/demos/index.html just works)
  • Tests run without compilation; library adopters that use x-test can easily adopt x-element's test suite into their own continuous integration routine. and running the tests is easy ( (/lib/@netflix/x-element/test/index.html just works)
  • Docs run without compilation; any Markdown previewer will work
  • Native, vanilla packages that publish their demos & tests can be members of a larger toolkit without jumping through any additional hoops: https://import.dog/list.html
  • It already works this way since Include /test and /demo in the published version of x-element #101 - discussion in Publishes tests and demos #103

Examples in the wild:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions