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

change script to add comments to all auto-patching operators to indicate generated file #1030

Closed
jeffbcross opened this issue Dec 10, 2015 · 9 comments

Comments

@jeffbcross
Copy link
Contributor

Since there is a script to generate all of the auto-patching operator modules inside the add folder whenever operators change, comments should be added to those files indicating that they should not be manually edited without updating the script.
i.e.

/**
 * Everything in this file is generated by the whatever-script.js
 * Any manual edits to this file will be lost next time the script is run.
 **/

The script is located at tools/generate-operator-patches.js and the affected files are in src/add*.

@jeffbcross jeffbcross assigned jeffbcross and unassigned jeffbcross Dec 10, 2015
@jeffbcross
Copy link
Contributor Author

Unassigning for now since I'll be offline for a few weeks.

@luisgabriel
Copy link
Contributor

I can work on this one.

@jeffbcross
Copy link
Contributor Author

@luisgabriel awesome! And to be clear, it's the script that should be updated to include comments in those files. I'll update the issue title to make it less ambiguous.

@jeffbcross jeffbcross changed the title Add comments to all auto-patching operators to indicate generated file change script to add comments to all auto-patching operators to indicate generated file Dec 16, 2015
@luisgabriel
Copy link
Contributor

@jeffbcross ok. ;)

@kevinvandervlist
Copy link
Contributor

Three small things I happened to come across while doing something unrelated:

a) On a fresh clone the generator fails because the following folder does not exist: ./src/operator/extended

b) The following files seem to be generated incorrectly (related to the kitchensink stuff?)

  • src/add/operator/distinctUntilKeyChanged.ts
  • src/add/operator/elementAt.ts
  • src/add/operator/exhaust.ts
  • src/add/operator/exhaustMap.ts
  • src/add/operator/find.ts
  • src/add/operator/findIndex.ts
  • src/add/operator/isEmpty.ts
  • src/add/operator/max.ts
  • src/add/operator/mergeScan.ts
  • src/add/operator/min.ts
  • src/add/operator/timeInterval.ts

c) Since the files will be autogenerated anyway, shouldn't they be removed from the source tree, and generated on build?

@kwonoj
Copy link
Member

kwonoj commented Dec 27, 2015

a / b can be discussed in PR #1097 directly - @luisgabriel , does current PR reflects this?

c - Think it depends on how we'll treat auto generated files. These files are not changing frequently (mostly won't, unless adding / removing new operator) doesn't necessarily to be generated per build everytime.

@luisgabriel
Copy link
Contributor

I think a and b are being covered by #1097.

@kwonoj
Copy link
Member

kwonoj commented Jan 11, 2016

Closing this issue by #1097 is checked in now.

@kwonoj kwonoj closed this as completed Jan 11, 2016
@lock
Copy link

lock bot commented Jun 7, 2018

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@lock lock bot locked as resolved and limited conversation to collaborators Jun 7, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants