fix: change outdir to generate correct code links

john-u commented 3 years ago

set outDir to lib as it is required by oclif-dev to correctly generate readme

relates to SmartThingsCommunity/smartthings-cli#200

Types of Changes

[x] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
[x] I have read the CONTRIBUTING document
[x] My code follows the code style of this project (npm run lint produces no warnings/errors)
[x] Any required documentation has been added
[ ] I have added tests to cover my changes

john-u commented 3 years ago

After further investigation, I've found I can achieve the same output by leaving outDir set to dist and instead setting the following repositoryPrefix in package.json

"oclif": {
    "repositoryPrefix": "<%- repo %>/blob/v<%- version %>/<%- _.replace(commandPath, 'dist', 'src') %>"
}

However, I am hesitant to patch it this way since it seems every OCLIF CLI I can find open source has lib as a Typescript outDir (it's generated this way by the oclif CLI). Having our outDir set to dist caused this issue and we can't guarantee there won't be other issues related to it now or in the future.

smartthingspi commented 3 years ago

:tada: This PR is included in version 1.4.2 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

SmartThingsCommunity / edge-cli-plugin

fix: change outdir to generate correct code links #19

Types of Changes