blueprint remove old files #92

kellyselden · 2016-12-18T06:12:59Z

…ripping Ember CLI: Production code stripping

stefanpenner · 2016-12-19T16:28:27Z

active/0000-blueprint-remove-old-files.md

+module.exports = {
+  // ...
+
+  oldFilesToRemove: [


It is possible to want to programmatically choose which files are to be deleted? For example, one may want to remove files only if present, or if a specific add-on is present or configuration is set. Given that, should this be declarative or imperative? (I'm not trying to say it one or the other, if possible declarative would be my preference).

It makes sense to me to dual function this property as taking an array or a function that returns an array. Is that what you're talking about?

its mostly because it is currently a property on the class, and not the instance. Which is a tad funky (although nice for simple addon mains)

I don't follow. Where do you suggest it be moved to?

As this this implementation will not land before Jan 1, 2017. I believe we can use ES6 feature:

module.exports = { get existingFilesToRemove() { return [ /* ... */ ] } }

This should enable both a reasonable API, and ensure the property exists on the instance and not the class.

yup confirmed node v4.x supports what we would need (if this approach is taken)

node-set v4 ✓ node.current = v4.6.2 s/s/broccoli-viz ╍{} node > a = { get foo() { return []; }} > a.foo # => []

I will update.

@stefanpenner - That is also available in 0.12 (its just ES5 getters no?).

@rwjblue yup!

stefanpenner · 2016-12-19T17:48:13Z

active/0000-blueprint-remove-old-files.md

+
+We'd like a declarative API for blueprints to delete files instead of only
+create. It would be essentially syntactic sugar for removing the file yourself
+in an `afterInstall` hook. It would be an array on the blueprint's `index.js`.


How do the deletion + addition rules compose?

For example:

default blueprint: adds .jshintrc

eslint blueprint: removes .jshintrc

Scenarios:

user runs the eslint blueprint for the first time, output would be:

file remove: .jshintrc

user then later runs ember init

One approach would result in:

file add: .jshintrc --- eslintrc addon file remove: .jshintrc

One approach would result in no output

One may output exactly what happened:

file ensured remove: .jshintrc

I was thinking it would be as basic as possible, and let git handle anything more complicated.

eslint removes .jshintrc

git commit

some time passes

ember init adds it back

git tells you this file you don't want was added back, so you manually remove the file

If we started composing, I think there would be many corner cases with a lot of complexity. My goal is to get old files out of the project that until now were invisible to you. With my steps above, it is now visible to you that it was removed for some reason, even though there are some extra steps to get rid of it again.

kellyselden · 2017-01-05T21:34:05Z

@stefanpenner I've addressed concerns. This is ready for more scrutiny, or approval. Possible bikeshedding on naming though.

cc @ember-cli/core

stefanpenner · 2017-01-05T22:01:44Z

active/0000-blueprint-remove-old-files.md

+
+# Drawbacks
+
+The only reason to not do this is to hold out for a large blueprint reworking.


I wouldn't worry about the blprnt extraction. That will take some more effort due to how the test harnesses work. And i don't mind backporting any work your doing there rather then blocking the world because i haven't finished that yet.

stefanpenner · 2017-01-05T22:03:11Z

active/0000-blueprint-remove-old-files.md

+
+We'd like an API for blueprints to delete files instead of only
+create. It would be essentially syntactic sugar for removing the file yourself
+in an `afterInstall` hook. It would be a returned array on the blueprint's `index.js`.


So today, file mutations are intended to be transactional. Specifically, it is possible cancel / say no abort a blueprint and abort. As described, this appears like it may not participate in that, is that the case?

I lied then 😛. It is not sugar for afterInstall after all, only in concept, because I believe I am still participating in the transactional system here: https://github.com/ember-cli/ember-cli/pull/6472/files#diff-3b6ee55eb49134b6b858dea4972b3117R736

Turbo87 · 2017-01-19T19:43:21Z

active/0000-blueprint-remove-old-files.md

+# Alternatives
+
+The key name can be bikeshed. I chose `oldFilesToRemove` to be verbose and
+explicit, but it can be changed.


@kellyselden oldFilesToRemove indicates that this should only be used for files there were previously part of the blueprint. what about other scenarios where files should be removed? e.g. eslint removing jshint files? I'm wondering if that key should be more generic

Great point. One main goal of this RFC is to settle on the best name.

kellyselden · 2017-01-19T21:47:34Z

This was discussed in the Ember CLI team meeting, and there are no more pressing concerns. This is now in Final Comment Period for the next 7 days.

les2 · 2017-01-21T19:55:25Z

active/0000-blueprint-remove-old-files.md

+
+# Motivation
+
+We want to eliminate the noise of having old files laying after updating


nit: grammar: "having old files lying around after"

les2

grammar

les2 · 2017-01-21T20:03:51Z

How would you register one of those files that include tokens in them

Maybe the oldFilesToRemove should be allowed to have tokens (same tokens as the ones available in the blueprint's files directory).

Edit: ~~Nevermind. I was thinking about something else. :)~~

I was thinking about the correct thing. The question still remains.

Example: A file like some/thing/__name__.js could be in the oldFilesToRemove if it was moved to some/other-place/__name__.js?

rwjblue · 2017-01-29T16:48:30Z

@les2:

Maybe the oldFilesToRemove should be allowed to have tokens (same tokens as the ones available in the blueprint's files directory).

Agreed, but this RFC doesn't prevent that (and it should be pretty easy to add in a followup PR).

rwjblue · 2017-01-29T16:50:12Z

This has been in final comment period for quite a bit, and no new complications have been raised.

Thank you all for reviewing and contributing!

This reverts commit be142aa, reversing changes made to b90f860. This is being reverted due to user experience issues when the `bower.json` file is no longer part of the blueprint. As things exist prior to a revert, any user upgrading from a version of ember-cli prior to 2.11 would never be instructed to update their `bower.json` to remove entries for `ember`, `ember-cli-shims`, etc. To bring this back, we need to land the ability for a blueprint to indicate that a file should be deleted as part of the `ember init` process. This was RFC'ed (ember-cli/rfcs#92) and should hopefully land in 2.13 (current ember-cli#master branch).

Revert changes removing `bower.json` from default blueprints. This reverts commit be142aa, reversing changes made to b90f860. This is being reverted due to user experience issues when the `bower.json` file is no longer part of the blueprint. As things exist prior to a revert, any user upgrading from a version of ember-cli prior to 2.11 would never be instructed to update their `bower.json` to remove entries for `ember`, `ember-cli-shims`, etc. To bring the changes being reverted back, we need to land the ability for a blueprint to indicate that a file should be deleted as part of the `ember init` process. This was RFC'ed in ember-cli/rfcs#92 and the implementation is pending in #6472 and should hopefully land in 2.13 (current ember-cli#master branch). This was discussed at the ember-cli meeting on 2017-01-26.

…-files blueprint remove old files

nathanhammond and others added 2 commits December 1, 2016 23:25

Merge pull request ember-cli#50 from GavinJoyce/gj/production-code-st…

e896286

…ripping Ember CLI: Production code stripping

blueprint remove old files

97ba1e7

stefanpenner reviewed Dec 19, 2016

View reviewed changes

changed to es6 instance function

cc78128

kellyselden mentioned this pull request Dec 22, 2016

Ember CLI 2016-12-15 emberjs/core-notes#123

Merged

stefanpenner reviewed Jan 5, 2017

View reviewed changes

nathanhammond force-pushed the master branch from 4200e6f to 21c205e Compare January 6, 2017 17:58

Turbo87 reviewed Jan 19, 2017

View reviewed changes

kellyselden added the Final Comment Period label Jan 19, 2017

les2 reviewed Jan 21, 2017

View reviewed changes

les2 suggested changes Jan 21, 2017

View reviewed changes

rwjblue merged commit c844410 into ember-cli:master Jan 29, 2017

rwjblue mentioned this pull request Jan 29, 2017

add ability to clean up old files in generators ember-cli/ember-cli#6472

Merged

kellyselden deleted the blueprint-remove-old-files branch January 29, 2017 18:28

rwjblue mentioned this pull request Jan 30, 2017

Revert changes removing bower.json from default blueprints. ember-cli/ember-cli#6731

Merged

kategengler pushed a commit to kategengler/rfcs that referenced this pull request Jan 19, 2019

Merge pull request ember-cli#92 from kellyselden/blueprint-remove-old…

0e9b216

…-files blueprint remove old files

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

blueprint remove old files #92

blueprint remove old files #92

kellyselden commented Dec 18, 2016

stefanpenner Dec 19, 2016

kellyselden Dec 19, 2016

stefanpenner Dec 19, 2016

kellyselden Dec 19, 2016

stefanpenner Dec 19, 2016 •

edited

Loading

stefanpenner Dec 19, 2016 •

edited

Loading

kellyselden Dec 19, 2016

rwjblue Dec 22, 2016

stefanpenner Dec 22, 2016

stefanpenner Dec 19, 2016

kellyselden Dec 19, 2016

kellyselden commented Jan 5, 2017

stefanpenner Jan 5, 2017

stefanpenner Jan 5, 2017

kellyselden Jan 5, 2017

Turbo87 Jan 19, 2017

kellyselden Jan 19, 2017

kellyselden commented Jan 19, 2017

les2 Jan 21, 2017

les2 left a comment

les2 commented Jan 21, 2017 •

edited

Loading

rwjblue commented Jan 29, 2017

rwjblue commented Jan 29, 2017


		# Drawbacks

		The only reason to not do this is to hold out for a large blueprint reworking.


		# Motivation

		We want to eliminate the noise of having old files laying after updating

blueprint remove old files #92

blueprint remove old files #92

Conversation

kellyselden commented Dec 18, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stefanpenner Dec 19, 2016 • edited Loading

Choose a reason for hiding this comment

stefanpenner Dec 19, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Scenarios:

user runs the eslint blueprint for the first time, output would be:

user then later runs ember init

Choose a reason for hiding this comment

kellyselden commented Jan 5, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kellyselden commented Jan 19, 2017

Choose a reason for hiding this comment

les2 left a comment

Choose a reason for hiding this comment

les2 commented Jan 21, 2017 • edited Loading

rwjblue commented Jan 29, 2017

rwjblue commented Jan 29, 2017

stefanpenner Dec 19, 2016 •

edited

Loading

stefanpenner Dec 19, 2016 •

edited

Loading

user then later runs `ember init`

les2 commented Jan 21, 2017 •

edited

Loading