[Discussion] Potential breaking changes for v6

[chrisblossom]

Looks like #190 will be released soon and will require a major version bump.

Are there any potential changes to the API that should be considered before releasing 6.0.0?

I personally would like to see this repository converted to typescript as it has a much larger community backing. I've recently made the switch and with some exceptions, I have found it a much more pleasant development experience. I'd be willing to put together an initial PR if that is something @davidtheclark @sudo-suhas @olsonpm is interested in. If not I completely understand...it isn't needed and somewhat "bikeshedding".

[davidtheclark]

Thanks for opening this, @chrisblossom.

Re TypeScript: At this point, I wouldn't mind switching to TypeScript — it would be a good educational opportunity for me, since I don't have experience with it — especially if you're interested in putting in the legwork. I'm assuming it won't require significant refactoring of non-type code: if it does, I'd be more hesitant. If you want to start a PR towards that, go for it. If you're finding yourself making more than type-level changes though, it may be a good idea to pause and discuss those before you put in too much work.

[chrisblossom]

I'm assuming it won't require significant refactoring of non-type code: if it does, I'd be more hesitant. ... If you're finding yourself making more than type-level changes though, it may be a good idea to pause and discuss those before you put in too much work.

Should be very straight forward with minimal changes necessary. I have a fair amount of experience what it takes to convert and update the build process. FYI, I don't think I'll have time to start on it until next week at the earliest.

I think the biggest change that you'll find is common js / module interop (which I think is currently an issue, just not very known). I think the best / most future proof solution is to remove default exports and use a named export instead. Relevant discussion: johnagan/clean-webpack-plugin#114

// es modules
import { cosmiconfig } from 'cosmiconfig';

// common js
const { cosmiconfig } = require('cosmiconfig');

[sudo-suhas]

While migrating to typescript(I too support this), we should try to use the --strict compiler option. However, I think we should minimise changes required for users to upgrade cosmiconfig unless there is a very good reason to do so.

[chrisblossom]

I put in PRs #192 #193 #194 #195 in preparation for typescript. The only one that is necessary is #194, the others are just things I noticed while updating the packages. Please close if they aren't wanted changes.

[chrisblossom]

Moved from #197 (comment):

• 1. Update build system to use babel and es modules. es modules and build system updates #198
• 2. Direct minimal migration from typescript -> flow Minimal migration to Typescript #201
• 3. Add code quality tools such as @typescript-eslint/eslint-plugin and fix any lint issues. (this was a big portion of the changed code) Typescript code quality tools #202
• 4. Code PR bugs / issues found when updating types. Consolidate types and fixes #204
• 5. Modernize code with async await. Modernize code #205
• 6. Open discussion / PRs with API change ideas.
  • Replace cosmiconfig.loaders with named export defaultLoaders Breaking: remove cosmiconfig.loaders and add named export defaultLoaders. #208
  • Use transformSync option for sync transform Breaking: Use transformSync option for sync transform #209
  • Only support options.loaders object format. Separate async sync api #211
  • Completely separate sync and async api. Separate async sync api #211
  • Export actual defaultLoaders object used by cosmiconfig. Export default loaders object #212

I've opened some PRs to start discussions with some breaking changes I'm proposing. I'm not sure they are the best API possible, but wanted to open the PRs to get the process started.

[chrisblossom]

After #211 and #212 the only PR left for me to do before a new release is published is to fix/update the dependencies because of the issue described in #206.

[davidtheclark]

I just released v6 🎈