@simplysf/simply-package 2.3.0 → 2.3.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @simplysf/simply-package
2
2
 
3
- [![NPM](https://img.shields.io/npm/v/@simplysf/simply-package.svg?label=@simplysf/simply-package)](https://www.npmjs.com/package/@simplysf/simply-package) [![Downloads/week](https://img.shields.io/npm/dw/@simplysf/simply-package.svg)](https://npmjs.org/package/@simplysf/simply-package) [![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD_3--Clause-yellow.svg)](https://raw.githubusercontent.com/SimplySF/simply-package/main/LICENSE.txt)
3
+ [![NPM](https://img.shields.io/npm/v/@simplysf/simply-package.svg?label=@simplysf/simply-package)](https://www.npmjs.com/package/@simplysf/simply-package) [![Downloads/week](https://img.shields.io/npm/dw/@simplysf/simply-package.svg)](https://npmjs.org/package/@simplysf/simply-package) [![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://raw.githubusercontent.com/SimplySF/simply/main/packages/simply-package/LICENSE.txt)
4
4
 
5
5
  ## Install
6
6
 
@@ -10,55 +10,19 @@ sf plugins install @simplysf/simply-package
10
10
 
11
11
  ## Issues
12
12
 
13
- Please report any issues at https://github.com/SimplySF/simply-package/issues
13
+ Please report any issues at https://github.com/SimplySF/simply/issues
14
14
 
15
15
  ## Contributing
16
16
 
17
- 1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)
18
- 2. Create a new issue before starting your project so that we can keep track of
19
- what you are trying to add/fix. That way, we can also offer suggestions or
20
- let you know if there is already an effort in progress.
21
- 3. Fork this repository.
22
- 4. [Build the plugin locally](#build)
23
- 5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
24
- 6. Edit the code in your fork.
25
- 7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
26
- 8. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
27
-
28
- ### Build
29
-
30
- To build the plugin locally, make sure to have yarn installed and run the following commands:
31
-
32
- ```bash
33
- # Clone the repository
34
- git clone git@github.com:SimplySF/simply-package
35
-
36
- # Install the dependencies and compile
37
- yarn && yarn build
38
- ```
39
-
40
- To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.
41
-
42
- ```bash
43
- # Run using local run file.
44
- ./bin/dev.cmd simply package
45
- ```
46
-
47
- There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
48
-
49
- ```bash
50
- # Link your plugin to the sf cli
51
- sf plugins link .
52
- # To verify
53
- sf plugins
54
- ```
17
+ This package is part of the [`@simplysf/simply`](https://github.com/SimplySF/simply) monorepo. See the repo's [CONTRIBUTING.md](../../CONTRIBUTING.md) for the repo structure, how to set up and build the project, our commit conventions, and how to submit a pull request. Please also read our [Code of Conduct](../../CODE_OF_CONDUCT.md).
55
18
 
56
19
  ## Commands
57
20
 
58
21
  <!-- commands -->
59
- * [`sf simply package dependencies install`](#sf-simply-package-dependencies-install)
60
- * [`sf simply package dependencies manage`](#sf-simply-package-dependencies-manage)
61
- * [`sf simply package version cleanup`](#sf-simply-package-version-cleanup)
22
+
23
+ - [`sf simply package dependencies install`](#sf-simply-package-dependencies-install)
24
+ - [`sf simply package dependencies manage`](#sf-simply-package-dependencies-manage)
25
+ - [`sf simply package version cleanup`](#sf-simply-package-version-cleanup)
62
26
 
63
27
  ## `sf simply package dependencies install`
64
28
 
@@ -255,4 +219,5 @@ FLAG DESCRIPTIONS
255
219
  ```
256
220
 
257
221
  _See code: [lib/commands/simply/package/version/cleanup.js](https://github.com/SimplySF/simply-package/blob/2.3.0/lib/commands/simply/package/version/cleanup.js)_
222
+
258
223
  <!-- commandsstop -->
@@ -1,5 +1,6 @@
1
1
  import { NamedPackageDir } from '@salesforce/core';
2
2
  import { InstalledPackages, PackagingSObjects } from '@salesforce/packaging';
3
+ import { BasePackageDirWithDependencies } from '../schemas/sfdx-project/packageDirs.js';
3
4
  type PackageInstallRequest = PackagingSObjects.PackageInstallRequest;
4
5
  export declare const PACKAGE_PREFIX_PACKAGE2 = "0Ho";
5
6
  export declare const PACKAGE_PREFIX_PACKAGE2_VERSION = "05i";
@@ -11,14 +12,5 @@ export declare const isSubscriberPackageId: (inputToEvaluate: string) => boolean
11
12
  export declare const isSubscriberPackageVersionId: (inputToEvaluate: string) => boolean;
12
13
  export declare const isSubscriberPackageVersionInstalled: (installedPackages: InstalledPackages[], subscriberPackageVersionId: string) => boolean;
13
14
  export declare const reducePackageInstallRequestErrors: (request: PackageInstallRequest) => string;
14
- export declare const isDependenciesPackagingDirectory: (packageDir: NamedPackageDir) => packageDir is NamedPackageDir & {
15
- path: string;
16
- default?: boolean | undefined;
17
- dependencies?: {
18
- [x: string]: unknown;
19
- package: string;
20
- versionNumber?: string | undefined;
21
- branch?: string | undefined;
22
- }[] | undefined;
23
- };
15
+ export declare const isDependenciesPackagingDirectory: (packageDir: NamedPackageDir) => packageDir is NamedPackageDir & BasePackageDirWithDependencies;
24
16
  export {};
package/lib/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,eAAe,EAAE,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,eAAe,EAAE,CAAC"}
package/package.json CHANGED
@@ -1,30 +1,15 @@
1
1
  {
2
2
  "name": "@simplysf/simply-package",
3
3
  "description": "Utilities for working with packages",
4
- "version": "2.3.0",
4
+ "version": "2.3.8",
5
5
  "author": "@ClayChipps",
6
- "bugs": "https://github.com/SimplySF/simply-package/issues",
7
- "dependencies": {
8
- "@oclif/core": "^4.11.2",
9
- "@salesforce/core": "^8.30.0",
10
- "@salesforce/kit": "^3.2.6",
11
- "@salesforce/packaging": "^4.22.16",
12
- "@salesforce/sf-plugins-core": "^12.2.16",
13
- "@inquirer/prompts": "^7.10.1",
14
- "@salesforce/ts-types": "^2.0.12",
15
- "zod": "^4.1.12"
6
+ "homepage": "https://github.com/SimplySF/simply",
7
+ "bugs": "https://github.com/SimplySF/simply/issues",
8
+ "repository": {
9
+ "type": "git",
10
+ "url": "https://github.com/SimplySF/simply",
11
+ "directory": "packages/simply-package"
16
12
  },
17
- "devDependencies": {
18
- "@oclif/plugin-command-snapshot": "^5.3.19",
19
- "@salesforce/cli-plugins-testkit": "^5.3.57",
20
- "@salesforce/plugin-command-reference": "^3.1.99",
21
- "@salesforce/ts-sinon": "^1.4.34",
22
- "@simplysf/dev-scripts": "^11.1.1",
23
- "eslint-plugin-sf-plugin": "^1.20.33",
24
- "oclif": "^4.23.0",
25
- "ts-node": "^10.9.2"
26
- },
27
- "config": {},
28
13
  "engines": {
29
14
  "node": ">=22.0.0"
30
15
  },
@@ -35,7 +20,6 @@
35
20
  "/oclif.lock",
36
21
  "/oclif.manifest.json"
37
22
  ],
38
- "homepage": "https://github.com/SimplySF/simply-package",
39
23
  "keywords": [
40
24
  "force",
41
25
  "salesforce",
@@ -46,6 +30,8 @@
46
30
  "sf"
47
31
  ],
48
32
  "license": "Apache-2.0",
33
+ "exports": "./lib/index.js",
34
+ "type": "module",
49
35
  "oclif": {
50
36
  "additionalVersionFlags": [
51
37
  "-v"
@@ -83,29 +69,41 @@
83
69
  },
84
70
  "topicSeparator": " "
85
71
  },
86
- "repository": "SimplySF/simply-package",
72
+ "dependencies": {
73
+ "@inquirer/prompts": "^7.10.1",
74
+ "@oclif/core": "^4.11.2",
75
+ "@salesforce/core": "^8.30.0",
76
+ "@salesforce/kit": "^3.2.6",
77
+ "@salesforce/packaging": "^4.22.16",
78
+ "@salesforce/sf-plugins-core": "^12.2.16",
79
+ "@salesforce/ts-types": "^2.0.12",
80
+ "zod": "^4.1.12"
81
+ },
82
+ "devDependencies": {
83
+ "@oclif/plugin-command-snapshot": "^5.3.19",
84
+ "@salesforce/cli-plugins-testkit": "^5.3.57",
85
+ "@salesforce/plugin-command-reference": "^3.1.99",
86
+ "@salesforce/ts-sinon": "^1.4.34",
87
+ "eslint-plugin-sf-plugin": "^1.20.33",
88
+ "oclif": "^4.23.0",
89
+ "ts-node": "^10.9.2"
90
+ },
91
+ "publishConfig": {
92
+ "access": "public"
93
+ },
87
94
  "scripts": {
88
95
  "build": "wireit",
89
- "clean": "sf-clean",
90
- "clean-all": "sf-clean all",
91
96
  "compile": "wireit",
92
- "docs": "sf-docs",
93
97
  "fix-license": "eslint src test --fix --rule \"header/header: [2]\"",
94
98
  "format": "wireit",
95
99
  "link-check": "wireit",
96
100
  "lint": "wireit",
97
- "postpack": "sf-clean --ignore-signing-artifacts",
98
- "prepack": "sf-prepack",
99
- "prepare": "sf-install",
100
101
  "readme": "oclif readme --no-aliases",
101
102
  "test": "wireit",
102
103
  "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 1200000 --parallel --jobs 5",
103
104
  "test:only": "wireit",
104
105
  "test:watch": "mocha --watch \"./test/**/*.test.ts\""
105
106
  },
106
- "publishConfig": {
107
- "access": "public"
108
- },
109
107
  "wireit": {
110
108
  "build": {
111
109
  "dependencies": [
@@ -221,6 +219,5 @@
221
219
  "output": []
222
220
  }
223
221
  },
224
- "exports": "./lib/index.js",
225
- "type": "module"
222
+ "gitHead": "da7382a69839e5df798bdbfe83f6f126f238dda3"
226
223
  }