@salesforce/plugin-packaging 0.0.1
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/CHANGELOG.md +5 -0
- package/LICENSE.txt +12 -0
- package/README.md +105 -0
- package/lib/commands/force/package/placeholder.d.ts +6 -0
- package/lib/commands/force/package/placeholder.js +18 -0
- package/lib/commands/force/package/placeholder.js.map +1 -0
- package/lib/index.d.ts +2 -0
- package/lib/index.js +9 -0
- package/lib/index.js.map +1 -0
- package/messages/messages.json +22 -0
- package/oclif.manifest.json +1 -0
- package/package.json +142 -0
package/CHANGELOG.md
ADDED
package/LICENSE.txt
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
Copyright (c) 2022, Salesforce.com, Inc.
|
|
2
|
+
All rights reserved.
|
|
3
|
+
|
|
4
|
+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
|
5
|
+
|
|
6
|
+
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
|
7
|
+
|
|
8
|
+
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
|
9
|
+
|
|
10
|
+
* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
|
11
|
+
|
|
12
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
package/README.md
ADDED
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# plugin-packaging;
|
|
2
|
+
|
|
3
|
+
> :warning: **This module is under heavy development, please do not use in production.**
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/@salesforce/plugin-packaging) [](https://circleci.com/gh/salesforcecli/plugin-packaging/tree/main) [](https://npmjs.org/package/@salesforce/plugin-packaging) [](https://raw.githubusercontent.com/salesforcecli/plugin-packaging/main/LICENSE.txt)
|
|
6
|
+
|
|
7
|
+
## This plugin provides the sfdx cli commands that support Salesforce Packaging Platform
|
|
8
|
+
|
|
9
|
+
## Learn about the plugin-packaging
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
sfdx plugins:install @salesforce/plugin-packaging@x.y.z
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Issues
|
|
18
|
+
|
|
19
|
+
Please report any issues at https://github.com/forcedotcom/cli/issues
|
|
20
|
+
|
|
21
|
+
## Contributing
|
|
22
|
+
|
|
23
|
+
1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)
|
|
24
|
+
2. Create a new issue before starting your project so that we can keep track of
|
|
25
|
+
what you are trying to add/fix. That way, we can also offer suggestions or
|
|
26
|
+
let you know if there is already an effort in progress.
|
|
27
|
+
3. Fork this repository.
|
|
28
|
+
4. [Build the plugin locally](#build)
|
|
29
|
+
5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
|
|
30
|
+
6. Edit the code in your fork.
|
|
31
|
+
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.
|
|
32
|
+
8. Sign CLA (see [CLA](#cla) below).
|
|
33
|
+
9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
|
|
34
|
+
|
|
35
|
+
### CLA
|
|
36
|
+
|
|
37
|
+
External contributors will be required to sign a Contributor's License
|
|
38
|
+
Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.
|
|
39
|
+
|
|
40
|
+
### Build
|
|
41
|
+
|
|
42
|
+
To build the plugin locally, make sure to have yarn installed and run the following commands:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
# Clone the repository
|
|
46
|
+
git clone git@github.com:salesforcecli/plugin-packaging.git
|
|
47
|
+
|
|
48
|
+
# Install the dependencies and compile
|
|
49
|
+
yarn install
|
|
50
|
+
yarn build
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
To use your plugin, run using the local `./bin/run` or `./bin/run.cmd` file.
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
# Run using local run file.
|
|
57
|
+
./bin/run package:create --help
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
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.
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
# Link your plugin to the sfdx cli
|
|
64
|
+
sfdx plugins:link .
|
|
65
|
+
# To verify
|
|
66
|
+
sfdx plugins
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Commands
|
|
70
|
+
|
|
71
|
+
<!-- commands -->
|
|
72
|
+
|
|
73
|
+
- [`sfdx force:package:placeholder [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forcepackageplaceholder---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
|
|
74
|
+
- [`sfdx version`](#sfdx-version)
|
|
75
|
+
|
|
76
|
+
## `sfdx force:package:placeholder [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
|
|
77
|
+
|
|
78
|
+
placeholder
|
|
79
|
+
|
|
80
|
+
```
|
|
81
|
+
USAGE
|
|
82
|
+
$ sfdx force:package:placeholder [--json] [--loglevel
|
|
83
|
+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
84
|
+
|
|
85
|
+
FLAGS
|
|
86
|
+
--json format output as json
|
|
87
|
+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
|
88
|
+
this command invocation
|
|
89
|
+
|
|
90
|
+
DESCRIPTION
|
|
91
|
+
placeholder
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
_See code: [src/commands/force/package/placeholder.ts](https://github.com/salesforcecli/plugin-packaging/blob/v0.0.1/src/commands/force/package/placeholder.ts)_
|
|
95
|
+
|
|
96
|
+
## `sfdx version`
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
USAGE
|
|
100
|
+
$ sfdx version
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v1.0.4/src/commands/version.ts)_
|
|
104
|
+
|
|
105
|
+
<!-- commandsstop -->
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Placeholder = void 0;
|
|
4
|
+
/*
|
|
5
|
+
* Copyright (c) 2022, salesforce.com, inc.
|
|
6
|
+
* All rights reserved.
|
|
7
|
+
* Licensed under the BSD 3-Clause license.
|
|
8
|
+
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
9
|
+
*/
|
|
10
|
+
const command_1 = require("@salesforce/command");
|
|
11
|
+
class Placeholder extends command_1.SfdxCommand {
|
|
12
|
+
async run() {
|
|
13
|
+
return Promise.resolve({});
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
exports.Placeholder = Placeholder;
|
|
17
|
+
Placeholder.description = 'placeholder';
|
|
18
|
+
//# sourceMappingURL=placeholder.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"placeholder.js","sourceRoot":"","sources":["../../../../src/commands/force/package/placeholder.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,iDAAkD;AAGlD,MAAa,WAAY,SAAQ,qBAAW;IAEnC,KAAK,CAAC,GAAG;QACd,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;;AAJH,kCAKC;AAJwB,uBAAW,GAAG,aAAa,CAAC"}
|
package/lib/index.d.ts
ADDED
package/lib/index.js
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/*
|
|
3
|
+
* Copyright (c) 2022, salesforce.com, inc.
|
|
4
|
+
* All rights reserved.
|
|
5
|
+
* Licensed under the BSD 3-Clause license.
|
|
6
|
+
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
|
+
*/
|
|
8
|
+
module.exports = {};
|
|
9
|
+
//# sourceMappingURL=index.js.map
|
package/lib/index.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;AAEH,iBAAS,EAAE,CAAC"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
{
|
|
2
|
+
"HelpDefaults": "If not supplied, the apiversion, template, and outputdir use default values.\n",
|
|
3
|
+
"HelpOutputDirRelative": "The outputdir can be an absolute path or relative to the current working directory.\n",
|
|
4
|
+
"HelpOutputDirRelativeLightning": "If you don’t specify an outputdir, we create a subfolder in your current working directory with the name of your bundle. For example, if the current working directory is force-app and your Lightning bundle is called myBundle, we create force-app/myBundle/ to store the files in the bundle.\n",
|
|
5
|
+
"HelpExamplesTitle": "\nExamples:\n",
|
|
6
|
+
"OutputDirFlagDescription": "folder for saving the created files",
|
|
7
|
+
"OutputDirFlagLongDescription": "The directory to store the newly created files. The location can be an absolute path or relative to the current working directory. The default is the current directory.",
|
|
8
|
+
"TemplateFlagDescription": "template to use for file creation",
|
|
9
|
+
"TemplateFlagLongDescription": "The template to use to create the file. Supplied parameter values or default values are filled into a copy of the template.",
|
|
10
|
+
"TargetDirOutput": "target dir = %s",
|
|
11
|
+
"App": "app",
|
|
12
|
+
"Event": "event",
|
|
13
|
+
"Interface": "interface",
|
|
14
|
+
"Test": "test",
|
|
15
|
+
"Component": "component",
|
|
16
|
+
"Page": "page",
|
|
17
|
+
|
|
18
|
+
"AlphaNumericNameError": "Name must contain only alphanumeric characters.",
|
|
19
|
+
"NameMustStartWithLetterError": "Name must start with a letter.",
|
|
20
|
+
"EndWithUnderscoreError": "Name can't end with an underscore.",
|
|
21
|
+
"DoubleUnderscoreError": "Name can't contain 2 consecutive underscores."
|
|
22
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":"0.0.1","commands":{"force:package:placeholder":{"id":"force:package:placeholder","description":"placeholder","strict":true,"usage":"<%= command.id %> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-packaging","pluginAlias":"@salesforce/plugin-packaging","pluginType":"core","aliases":[],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"}},"args":[]}}}
|
package/package.json
ADDED
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@salesforce/plugin-packaging",
|
|
3
|
+
"description": "SFDX plugin that support Salesforce Packaging Platform",
|
|
4
|
+
"version": "0.0.1",
|
|
5
|
+
"main": "lib/index.js",
|
|
6
|
+
"author": "Salesforce",
|
|
7
|
+
"bugs": "https://github.com/forcedotcom/cli/issues",
|
|
8
|
+
"dependencies": {
|
|
9
|
+
"@oclif/core": "^1.9.0",
|
|
10
|
+
"@oclif/plugin-version": "^1.0.4",
|
|
11
|
+
"@salesforce/command": "^5.1.3",
|
|
12
|
+
"@salesforce/core": "^3.19.5",
|
|
13
|
+
"tslib": "^2"
|
|
14
|
+
},
|
|
15
|
+
"devDependencies": {
|
|
16
|
+
"@oclif/plugin-command-snapshot": "^3.1.3",
|
|
17
|
+
"@salesforce/cli-plugins-testkit": "^1.5.3",
|
|
18
|
+
"@salesforce/dev-config": "^2.1.3",
|
|
19
|
+
"@salesforce/dev-scripts": "^1.0.4",
|
|
20
|
+
"@salesforce/plugin-command-reference": "^1.3.20",
|
|
21
|
+
"@salesforce/prettier-config": "^0.0.2",
|
|
22
|
+
"@salesforce/ts-sinon": "1.3.21",
|
|
23
|
+
"@salesforce/ts-types": "^1.5.20",
|
|
24
|
+
"@typescript-eslint/eslint-plugin": "^4.33.0",
|
|
25
|
+
"@typescript-eslint/parser": "^4.33.0",
|
|
26
|
+
"chai": "^4.3.6",
|
|
27
|
+
"cz-conventional-changelog": "^3.3.0",
|
|
28
|
+
"eslint": "^7.32.0",
|
|
29
|
+
"eslint-config-prettier": "^8.5.0",
|
|
30
|
+
"eslint-config-salesforce": "^0.1.6",
|
|
31
|
+
"eslint-config-salesforce-license": "^0.1.6",
|
|
32
|
+
"eslint-config-salesforce-typescript": "^0.2.8",
|
|
33
|
+
"eslint-plugin-header": "^3.1.1",
|
|
34
|
+
"eslint-plugin-import": "^2.26.0",
|
|
35
|
+
"eslint-plugin-jsdoc": "^35.5.1",
|
|
36
|
+
"eslint-plugin-prettier": "^3.4.1",
|
|
37
|
+
"husky": "^7.0.4",
|
|
38
|
+
"lint-staged": "^11.2.6",
|
|
39
|
+
"mocha": "^8.4.0",
|
|
40
|
+
"nyc": "^15.1.0",
|
|
41
|
+
"oclif": "^3.0.1",
|
|
42
|
+
"prettier": "^2.4.1",
|
|
43
|
+
"pretty-quick": "^3.1.3",
|
|
44
|
+
"shx": "0.3.4",
|
|
45
|
+
"sinon": "^11.1.2",
|
|
46
|
+
"ts-node": "^10.8.1",
|
|
47
|
+
"typescript": "^4.6.4"
|
|
48
|
+
},
|
|
49
|
+
"config": {
|
|
50
|
+
"commitizen": {
|
|
51
|
+
"path": "cz-conventional-changelog"
|
|
52
|
+
}
|
|
53
|
+
},
|
|
54
|
+
"engines": {
|
|
55
|
+
"node": ">=12.0.0"
|
|
56
|
+
},
|
|
57
|
+
"files": [
|
|
58
|
+
"/lib",
|
|
59
|
+
"/messages",
|
|
60
|
+
"/oclif.manifest.json"
|
|
61
|
+
],
|
|
62
|
+
"homepage": "https://github.com/salesforcecli/plugin-packaging",
|
|
63
|
+
"keywords": [
|
|
64
|
+
"force",
|
|
65
|
+
"salesforce",
|
|
66
|
+
"sfdx",
|
|
67
|
+
"salesforcedx",
|
|
68
|
+
"sfdx-plugin"
|
|
69
|
+
],
|
|
70
|
+
"license": "BSD-3-Clause",
|
|
71
|
+
"oclif": {
|
|
72
|
+
"commands": "./lib/commands",
|
|
73
|
+
"bin": "sfdx",
|
|
74
|
+
"additionalVersionFlags": [
|
|
75
|
+
"-v"
|
|
76
|
+
],
|
|
77
|
+
"additionalHelpFlags": [
|
|
78
|
+
"-h"
|
|
79
|
+
],
|
|
80
|
+
"devPlugins": [
|
|
81
|
+
"@oclif/plugin-help",
|
|
82
|
+
"@oclif/plugin-command-snapshot",
|
|
83
|
+
"@salesforce/plugin-command-reference"
|
|
84
|
+
],
|
|
85
|
+
"plugins": [
|
|
86
|
+
"@oclif/plugin-version"
|
|
87
|
+
],
|
|
88
|
+
"topics": {
|
|
89
|
+
"force": {
|
|
90
|
+
"description": "tools for the Salesforce developer",
|
|
91
|
+
"longDescription": "Commands to develop on the Salesforce Platform.",
|
|
92
|
+
"trailblazerCommunityLink": {
|
|
93
|
+
"url": "https://success.salesforce.com/_ui/core/chatter/groups/GroupProfilePage?g=0F93A000000HTp1",
|
|
94
|
+
"name": "Salesforce DX"
|
|
95
|
+
},
|
|
96
|
+
"subtopics": {
|
|
97
|
+
"package": {
|
|
98
|
+
"description": "develop and install packages",
|
|
99
|
+
"longDescription": "Use the package commands to develop and install packages.",
|
|
100
|
+
"trailblazerCommunityLink": {
|
|
101
|
+
"url": "https://success.salesforce.com/_ui/core/chatter/groups/GroupProfilePage?g=0F93A000000Lg5U",
|
|
102
|
+
"name": "Unlocked Packages and Managed 2GPs"
|
|
103
|
+
},
|
|
104
|
+
"subtopics": {
|
|
105
|
+
"placeholder": {
|
|
106
|
+
"description": "placeholder"
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
},
|
|
114
|
+
"repository": "salesforcecli/plugin-packaging",
|
|
115
|
+
"scripts": {
|
|
116
|
+
"build": "sf-build",
|
|
117
|
+
"clean": "sf-clean",
|
|
118
|
+
"clean-all": "sf-clean all",
|
|
119
|
+
"clean:lib": "shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -f oclif.manifest.json",
|
|
120
|
+
"compile": "sf-compile",
|
|
121
|
+
"docs": "sf-docs",
|
|
122
|
+
"format": "sf-format",
|
|
123
|
+
"lint": "sf-lint",
|
|
124
|
+
"postpack": "shx rm -f oclif.manifest.json",
|
|
125
|
+
"posttest": "yarn lint && yarn test:deprecation-policy && yarn test:command-reference",
|
|
126
|
+
"prepack": "sf-prepack",
|
|
127
|
+
"prepare": "sf-install",
|
|
128
|
+
"pretest": "sf-compile-test",
|
|
129
|
+
"test": "sf-test",
|
|
130
|
+
"test:command-reference": "./bin/run commandreference:generate --erroronwarnings",
|
|
131
|
+
"test:deprecation-policy": "./bin/run snapshot:compare",
|
|
132
|
+
"test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
|
|
133
|
+
"version": "oclif readme"
|
|
134
|
+
},
|
|
135
|
+
"publishConfig": {
|
|
136
|
+
"access": "public"
|
|
137
|
+
},
|
|
138
|
+
"sfdx": {
|
|
139
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-packaging/0.0.1.crt",
|
|
140
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-packaging/0.0.1.sig"
|
|
141
|
+
}
|
|
142
|
+
}
|