Update template files #8
Conversation
|
Some QA Notes:
|
tsconfig.json
Outdated
| @@ -1,7 +1,10 @@ | |||
| { | |||
| "extends": "@salesforce/dev-config/tsconfig-strict", | |||
| "compilerOptions": { | |||
| "outDir": "./lib" | |||
| "outDir": "./lib", | |||
| "skipLibCheck": true, | |||
There was a problem hiding this comment.
Is this necessary? Would be nice to avoid it if possible
There was a problem hiding this comment.
Both STL and SDR have this set. Within the last year, Shane suggested I turned this on in a different plugin that was having issues with glob types. How about I comment this out so folks can easily reenable this if they need it? The template commpiles fine without it.
There was a problem hiding this comment.
This applies to the graceful-fs question too.
Given that this is an internal-only template that's not widely used (if at all) I would argue that there's not much reason to spoon feed libraries and compiler options to people. I'd rather keep it as bare-bones as possible and trust that whoever is using the library understands what they're doing.
I think my concern is that things like this don't ever get removed because they came with the template. So with skipLibCheck you're opening the potential for type errors at runtime.
But like I said, this isn't widely used so it probably doesn't matter too much in the long run.
There was a problem hiding this comment.
That's perfectly fair. I'll remove both of these things 👍 Thanks for the review
| * All rights reserved. | ||
| * Licensed under the BSD 3-Clause license. | ||
| * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause | ||
| */ | ||
|
|
||
| import { Messages, Logger } from '@salesforce/core'; | ||
|
|
||
| Messages.importMessagesDirectory(__dirname); |
There was a problem hiding this comment.
Seeing __dirname made me wonder if we should convert the package to ESM? Or maybe have one template for both?? Or maybe just keep it CJS until it becomes an issue
There was a problem hiding this comment.
Let's wait for now. We can migrate it when we migrate STL and SDR
package.json
Outdated
| "@salesforce/core": "^6.7.0", | ||
| "@salesforce/kit": "^3.0.15", | ||
| "@salesforce/ts-types": "^2.0.9", | ||
| "graceful-fs": "^4.2.11" |
There was a problem hiding this comment.
Is graceful-fs used anywhere?
There was a problem hiding this comment.
It is not, but it is used in both Source Tracking and Source Deploy Retrieve. Fs operations will be common in libraries, I thought I would leave it as a suggestion to take advantage of.
Updates template files to be in sync with current standards.
The
source-deploy-retrieveandsource-trackingrepos were used as a reference.See QA notes below.
Test with: salesforcecli/plugin-dev#492
@W-15235736@