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

Intention to deprecate: Dev() method will no longer be supported #134

Closed
atruskie opened this issue Oct 30, 2017 · 1 comment
Closed

Intention to deprecate: Dev() method will no longer be supported #134

atruskie opened this issue Oct 30, 2017 · 1 comment

Comments

@atruskie
Copy link
Member

The command line interface (CLI) was designed to support supplying arguments through code during development.

This is bad practice because:

  • irrelevant code and CLI arguments are checked into the repository
  • a build is required to run the application with different arguments
  • discourages actual use of the CLI (and thus we aren't dogfooding our product)
  • custom and complex code was written to support this use case

Alternatives

  • To support easy launching I recommend using this plugin: SwitchStartupProject
  • We also have a (Windows only) automatic debug feature that can be used by specifying the -d switch on the command line
    • In this case, the recommended method to save often used commands is a text document saved somewhere outside this repository
  • Write unit tests that test functionality automatically (not feasible for all cases)
  • We're in the process of writing better documentation (Improve AP.exe documentation #130) which should alleviate some of the code based documentation provided by these methods.

Migration

We're going to sunset this feature very slowly. During this time sunsetting will involve various stages:

  1. [Obsolete] attributes will be attached to Dev methods
  2. NotSupportedExceptions will slowly replace Dev() calls
  3. Dev methods and files will be deleted
atruskie added a commit that referenced this issue Oct 31, 2017
Dev methods for cli commands are problematic and are scheduled for deprecation. This is the first step in removing these methods.

See #134
@atruskie atruskie changed the title Intention to deprecate: Dev() method will no longer supported Intention to deprecate: Dev() method will no longer be supported Nov 23, 2017
towsey added a commit that referenced this issue Nov 28, 2017
Partly addresses #134 .
Refactor the sandpit.cs class to accomodate depracated Dev methods.
atruskie added a commit that referenced this issue Nov 29, 2017
Dev methods for cli commands are problematic and are scheduled for deprecation. This is the first step in removing these methods.

See #134
@atruskie atruskie added this to the Future milestone Dec 4, 2017
@atruskie atruskie mentioned this issue Dec 5, 2017
31 tasks
atruskie pushed a commit that referenced this issue Dec 18, 2017
Partly addresses #134 .
Refactor the sandpit.cs class to accomodate depracated Dev methods.
atruskie pushed a commit that referenced this issue Dec 18, 2017
More work debugging gap rendering for missing recordings

Also deleted Dev method - addresses #134
atruskie pushed a commit that referenced this issue Jan 30, 2018
Partly addresses #134 .
Refactor the sandpit.cs class to accomodate depracated Dev methods.
Original hash: dde4da7
atruskie pushed a commit that referenced this issue Jan 30, 2018
Partly addresses #134 .
Refactor the sandpit.cs class to accomodate depracated Dev methods.
Original hash: 8019f06
atruskie pushed a commit that referenced this issue Jan 30, 2018
More work debugging gap rendering for missing recordings
Also deleted Dev method - addresses #134
Original hash: ddde715
@atruskie atruskie modified the milestones: Future, Open Source Feb 2, 2018
@atruskie
Copy link
Member Author

atruskie commented Mar 1, 2018

All Dev methods were successfully removed in acfd88b

@atruskie atruskie closed this as completed Mar 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant