Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DRAFT] Proposal: scopes for more tailored datafiles #285

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

Conversation

fahad19
Copy link
Member

@fahad19 fahad19 commented Mar 16, 2024

What's proposed

New API for introduced for more tailored and optimized datafile generation without affecting any existing users negatively.

Proposal is written as documentation as if the functionality already exists.

Once we collect further feedback, implementation will begin in the same PR.

TODOs

  • Write docs assuming the functionality already exists
  • Allow project configuration to accept scopes
  • Create example project for play with scopes
  • Create function for creating scoped datafiles out of tagged datafiles
  • Write (failing) tests for scoped datafile creating function
  • Honour scopes by generating scoped datafiles via $ npx featurevisor build
  • Allow test specs for features to run against scope
  • Write test specs against scope in example project
  • Make all tests pass
  • Attack it with many more complex cases

How to try it out locally

Clone the repo first, and do:

$ make install
$ make build

Example project

Found in ./examples/example-yml-scopes

$ (cd examples/example-yml-scopes && npm run build)

See output in ./examples/example-1/dist directory.

Core package

This is the datafile builder:

$ (cd ./packages/core && npm run build && npm test)

@fahad19 fahad19 self-assigned this Mar 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant