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

File changes missing in master branch / 14.1.1 #1200

Closed
jChris85 opened this issue Oct 9, 2019 · 7 comments
Closed

File changes missing in master branch / 14.1.1 #1200

jChris85 opened this issue Oct 9, 2019 · 7 comments

Comments

@jChris85
Copy link

jChris85 commented Oct 9, 2019

It seems like that there are some changes missing in the master branch regarding file extentions.

In the README.md in the section Common Configuration Options it says that the default values for extension are the following file extensions:

['.js', '.cjs', '.mjs', '.ts', '.tsx', '.jsx']

I also can see in the history that this change was made to a couple of files like instument.js, report.js and config-util.js.

Here is the commit for these changes: 914b776#diff-04c6e90faac2675aa89e2176d2eec7d8

Seems like something went wrong during merge or the changes where not merged to master at all.

Because of this you have always to add the extension option if you want to support other file extensions then .js.

@coreyfarrell
Copy link
Member

This was merged correctly. All defaults were recently moved to @istanbuljs/schema. Note this change was not merged to 14.x, it is for 15+ only. For README.md about 14.1.1 see https://github.com/istanbuljs/nyc/tree/v14.1.1#readme.

@coreyfarrell
Copy link
Member

Additional note nyc 15.0.0-beta.0 was released yesterday. For more information see #1104.

@jChris85
Copy link
Author

jChris85 commented Oct 9, 2019

Ok I get it. Now I can see that the readme says only js files are the default extensions for version 14.1.1.

But it is really confusing that the readme for the master branch says something which is not applicable for the lastest stable release, which is 14.1.1

@coreyfarrell
Copy link
Member

That's how github works, it shows the master branch which is the latest development version of files. 🤷‍♂️

Note also https://www.npmjs.com/package/nyc always shows information about the latest stable version. Github is for development, npmjs.com is for published releases.

@giovannicanzio
Copy link

That's how github works by default, actually.
In repo's settings you can set a base branch where all pull requests refer to.
On my - maybe wrong? - point of view, master branch, especially when it's a base branch, should be in sync with the lastest tag/stable release and, consequently, its readme consequent with what the dev gets while pulling.
I find the project definitely useful and appreciate your job, that's why I share and show confusion with @jChris85 .
Maybe declaring a branching policy could help. In the end best practices apply till you find something more suitable for your specific project.
For the moment, I also find the information provided by the master readme confusing as not complying with what I get in the latest stable version installed by npm.

coreyfarrell added a commit to coreyfarrell/nyc that referenced this issue Oct 9, 2019
This causes confusion amongst users who think they're reading about the
latest releaase.  It is better that we send users to istanbul.js.org for
documentation.

Issue istanbuljs#1200
coreyfarrell added a commit to coreyfarrell/nyc that referenced this issue Oct 9, 2019
This causes confusion among users who think they're reading about the
latest releaase.  It is better that we send users to istanbul.js.org for
documentation.

Issue istanbuljs#1200
@coreyfarrell
Copy link
Member

The base branch setting controls what is shown at https://github.com/istanbuljs/nyc and controls where PR's go, so changing the base branch would create confusion and burden for contributors and maintainers. One thing I hadn't realized is by default homepage of package.json points to the github readme, I thought npm home nyc brought people to npmjs.com. This is something I can address, I'll be pointing it to https://istanbul.js.org/.

@giovannicanzio
Copy link

That sounds better, thank you.

coreyfarrell added a commit that referenced this issue Nov 3, 2019
This causes confusion among users who think they're reading about the
latest releaase.  It is better that we send users to istanbul.js.org for
documentation.

Issue #1200
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

3 participants