chore: misc prep for release with ES modules, yargs, and nexe builds #788
Conversation
|
rossiam
force-pushed
the
prerelease-prep
branch
11 times, most recently
from
78cfb49 to
c633832
Compare
rossiam
force-pushed
the
prerelease-prep
branch
from
c633832 to
40ee2e3
Compare
CHANGELOG.md
Outdated
| * All commands now have examples in their help (`smartthings <command> --help`). | ||
| * args that require enum-like types are now case-insensitive. e.g. You can now list zigbee devices | ||
| with `smartthings devices --type zigbee`. | ||
| * The config file location is now determined by https://www.npmjs.com/package/env-paths[envPaths] library |
There was a problem hiding this comment.
Heh, oops. That was asciidoc format. Fixed.
CHANGELOG.md
Outdated
| rather than an argument. e.g. `smartthings capabilities myteam.myCapability --capability-version 1` | ||
| instead of `smartthings capabilities myteam.myCapability 1`. Note that the version is always one, | ||
| so this flag is not necessary at this time. | ||
| * We now use ES modules. |
There was a problem hiding this comment.
Probably can replace these with something more generic since they don't impact end user features.
|
|
||
| The CLI can be used on any platform that supports Node 24. | ||
|
|
||
| First, install at least [Node version 24.8.0](https://nodejs.org/en/download/current) on your machine. |
There was a problem hiding this comment.
This link will likely change to something else in the near future rather than node 24. Do you want to just say latest Node or did you need it to say 24 specifically? If so maybe there is a direct link to node24 that can be used.
There was a problem hiding this comment.
As discussed in chat, I'm just going to leave this. It's okay if they install a newer version.
| name: 'smartthings', | ||
| input: packFile, | ||
| resources: ['package.json'], | ||
| remote: 'https://github.com/SmartThingsCommunity/cli-nexe-builds/releases/download/1.0.0', |
There was a problem hiding this comment.
This doesn't seem to resolve? Should the 1.0.0 be the node version?
There was a problem hiding this comment.
This is correct. It is true that it doesn't resolve in a web browser but I don't think nexe ever tries to resolve this URL by itself. It's adding the asset name to it and resolving that.
(Look at the URLs for the assets on this page:
https://github.com/SmartThingsCommunity/cli-nexe-builds/releases/tag/1.0.0
It's the base of all of them.)
rossiam
force-pushed
the
prerelease-prep
branch
2 times, most recently
from
a9d4baa to
be98ce5
Compare
rossiam
force-pushed
the
prerelease-prep
branch
from
be98ce5 to
80b5426
Compare
This PR includes stuff to prepare for a yargs/ES modules prerelease:
update-readme.tsthat lists commands in the README; for now, it just lists commands with their descriptionsconfiguration.mdwith updated config file location infopackage.jsonpkgtoolreadmecommand/script now runs newupdate-readmescriptpackagecommand/readme now runs newbuild-binariesscriptzip-binarieshas been rolled intopackageand has been remove.completionoption which adds acompletioncommandncc, we get theseCHANGELOG.md