Skip to content

Commit c8c6e8a

Browse files
committed
chore: clean up remnants of oclif and some bad links
1 parent a80be15 commit c8c6e8a

6 files changed

Lines changed: 10 additions & 20 deletions

File tree

.gitignore

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,6 @@ jest-html-reporters-attach
1717
jest_html_reporters.html
1818
smartthings-*.zip
1919

20-
# the Typescript outDir that oclif prefers
21-
packages/cli/lib
22-
packages/edge/lib
23-
2420
# functional tests
2521
.pytest_cache
2622
__pycache__

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
- All commands now have examples in their help (`smartthings <command> --help`).
2828
- args that require enum-like types are now case-insensitive. e.g. For example, you can now list zigbee
2929
devices with `smartthings devices --type zigbee`.
30-
- The config file location is now determined by [envPaths](https://www.npmjs.com/package/env-paths) library
30+
- The config file location is now determined by [env-paths](https://www.npmjs.com/package/env-paths) library
3131
rather than oclif. A reasonable attempt has been made at finding the old config and copying it for
3232
the user so normally no change is needed. (Future changes will need to be made to the new file, of course.)
3333
The `config` command now displays the location of the configuration file.

CONTRIBUTING.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,7 @@ commands. Some ground rules to follow when creating or updating commands:
5757
* Commands should be kebab case. The module name is used as the command name and can be placed in
5858
a topic by placing it in that topic's directory.
5959
* Commands should always include a short one-line description that starts with a lowercase letter
60-
and does not end with a period. A more detailed description can be included after a newline. This
61-
description can be split across lines but should not include newlines (oclif will wrap it).
60+
and does not end with a period. More details can be provided in the epilog if necessary.
6261
* Flags are also kebab case and should have a short single-character version only if they are
6362
expected to be used often.
6463
* Descriptions of flags should be short, start with a lowercase letter, and include no ending
@@ -68,12 +67,9 @@ commands. Some ground rules to follow when creating or updating commands:
6867
* Descriptions for arguments should be a short phrase without a capital letter and without ending
6968
punctuation.
7069
* Examples of common tasks should be included with a description of the example.
71-
* Use the [object format](https://oclif.io/docs/commands#other-command-options)
72-
rather than the simple string format when providing examples.
7370
* When specifying an id in an example, use a representative example id.
7471
* One-line descriptions should start with a lowercase letter and not end with a period.
75-
* There is no need to include `$ ` prefix for command examples because oclif includes it
76-
automatically.
72+
* Use `$0` in place of `smartthings` in the example.
7773

7874
### Command Naming
7975

@@ -138,7 +134,7 @@ If you are not familiar with SmartThings, we have
138134
[extensive online documentation](https://developer.smartthings.com/docs/getting-started/welcome/).
139135

140136
To create and manage your services and devices on SmartThings, create an account in the
141-
[developer workspace](https://smartthings.developer.samsung.com/workspace/).
137+
[developer console](https://developer.smartthings.com/console).
142138

143139
The [SmartThings Community](https://community.smartthings.com/) is a good place share and
144140
ask questions.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ asking you to log in and give the CLI permission to access your account.
9696
The CLI will automatically request login as needed.
9797

9898
You can also use a personal access token (PAT) for authentication by passing a `--token <uuid>` flag to commands or by creating a
99-
[configuration file](https://github.com/SmartThingsCommunity/smartthings-cli/blob/main/packages/cli/doc/configuration.md)
99+
[configuration file](https://github.com/SmartThingsCommunity/smartthings-cli/blob/main/doc/configuration.md)
100100
and including the token in a `token` key for your profile. We generally don't recommend this approach
101101
since it less secure, given that PATs don't expire unless revoked by the user, but it can be useful when working with
102102
headless servers or for users who frequently switch between accounts.
@@ -285,4 +285,4 @@ $ SMARTTHINGS_DEBUG=true smartthings <command>
285285
```
286286

287287
More details about advanced configuration and logging in the CLI can be found on the
288-
[configuration documentation page](https://github.com/SmartThingsCommunity/smartthings-cli/blob/master/packages/cli/doc/configuration.md).
288+
[configuration documentation page](https://github.com/SmartThingsCommunity/smartthings-cli/blob/main/doc/configuration.md).

doc/configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,10 @@ Command line flags always override configuration options.
103103

104104
Logging is useful when you are developing the CLI itself or if you need to debug an issue experienced during general use.
105105

106-
By default, a rolling log file will be created at the [OCLIF CLI cache](https://oclif.io/docs/config) directory.
107-
* macOS: `~/Library/Caches/@smartthings/cli`
108-
* Unix: `~/.cache/@smartthings/cli`
109-
* Windows: `%LOCALAPPDATA%\@smartthings\cli`
106+
By default, a rolling log file will be created at the log directory specified by [env-paths](https://www.npmjs.com/package/env-paths) directory.
107+
* macOS: `~/Library/Logs/@smartthings/cli`
108+
* Unix: `~/.local/state/@smartthings/cli` (or `$XDG_STATE_HOME/@smartthings/cli`)
109+
* Windows: `%LOCALAPPDATA%\@smartthings\cli\Log`
110110

111111
The CLI uses [log4js](https://log4js-node.github.io/log4js-node/) for logging.
112112

src/lib/command/util/installedschema-util.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ export const installedSchemaInstances = async (
1515
locationIds: string[] | undefined,
1616
options: { verbose: boolean },
1717
): Promise<(InstalledSchemaApp & WithNamedLocation)[]> => {
18-
// We accept and handle undefined locationIds because that's what we get from oclif even
19-
// though the type is just `string[]`.
2018
if (!locationIds || locationIds.length == 0) {
2119
locationIds = (await client.locations.list()).map(it => it.locationId)
2220
}

0 commit comments

Comments
 (0)