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

Deprecate paramsMaker #667

Closed
cdupuis opened this issue Jan 30, 2019 · 4 comments
Closed

Deprecate paramsMaker #667

cdupuis opened this issue Jan 30, 2019 · 4 comments
Assignees
Labels
changelog:changed Add this issue or pull request to changed changelog section changelog:deprecated Add this issue or pull request to deprecated changelog section enhancement New feature or request

Comments

@cdupuis
Copy link
Member

cdupuis commented Jan 30, 2019

No description provided.

@cdupuis cdupuis added enhancement New feature or request changelog:deprecated Add this issue or pull request to deprecated changelog section changelog:changed Add this issue or pull request to changed changelog section labels Jan 30, 2019
@cdupuis cdupuis self-assigned this Jan 30, 2019
@lievendoclo
Copy link
Contributor

So you mean deprecating the annotation based parameters?

@cdupuis
Copy link
Member Author

cdupuis commented Jan 30, 2019

So you mean deprecating the annotation based parameters?

Not sure if I want to deprecate the actual decorators as they are being used actively by old style automation clients. But deprecate the paramsMaker property of CommandHandlerRegistration and GeneratorRegistration etc might be a start.

@johnsonr
Copy link
Contributor

Yes. We should discourage the annotation style as the newer parameters model is more composable and less magical. It now enforces that parameter definitions match the relevant interface, which eliminates the last reason to use decorators.

@lievendoclo
Copy link
Contributor

Ok agreed, but I'd change the documentation to have the parameterDefinition variables typed, i.e.:

const helloWorldParametersDefinition: ParametersDefinition = {
        name: { description: "name",
            required: true,
            pattern: /.*/ },
        location: {},
    };

That way people have code completion in IDEs.

atomist-bot added a commit that referenced this issue Jan 31, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog:changed Add this issue or pull request to changed changelog section changelog:deprecated Add this issue or pull request to deprecated changelog section enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants