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

Do not assume a default name for the specification file #133

Open
StoneyJackson opened this issue May 1, 2024 · 2 comments
Open

Do not assume a default name for the specification file #133

StoneyJackson opened this issue May 1, 2024 · 2 comments

Comments

@StoneyJackson
Copy link
Member

plccmk defines default names for specification files and a priority among them: "first look for 'spec', then look for 'grammar'".

Based on discussion in #125 , I think we should remove the default from plccmk and require users to supply the path to the file as a command line argument.

plccmk grammar
plccmk ../relative/to/cwd/spec
plccmk /absolute/to/thingamajig

Advantages:

  1. Less magic for the user; explicit connection between the command and the file it operates on.
  2. Allows instructors to use whatever naming convention they feel is best.
  3. Simplifies plccmk logic.

Disadvantages:

  1. Breaks existing course materials that use plccmk with a default file name and location.
@StoneyJackson StoneyJackson mentioned this issue May 1, 2024
@jashelio
Copy link
Collaborator

jashelio commented May 2, 2024 via email

@StoneyJackson
Copy link
Member Author

AGREED, but don't forget to change the course materials.

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

No branches or pull requests

2 participants