sf-plugin-permission-sets 0.0.0-dev → 0.0.0-dev.10

package/README.md

@@ -16,10 +16,12 @@ Stop clicking through Setup to grant access. Commit a YAML file, open a PR, let
 - [Quick start](#quick-start)
 - [Permission files](#permission-files)
 - [Organizing files](#organizing-files)
+- [Validations](#validations)
 - [Modes](#modes)
 - [Commands](#commands)
 - [CI/CD](#cicd)
 - [Inspiration & equivalents](#inspiration--equivalents)
+- [Versioning](#versioning)
 
 ---
 
@@ -153,6 +155,18 @@ sf ps apply -o qa   --file "permissions/qa/*.yml"
 
 The two compose: a directory per environment, each split into functional files.
 
+## Validations
+
+Every run checks the files first. `check` runs the offline checks with no org, and `validate` adds the org-side checks. When files merge, most overlaps are unions rather than errors.
+
+| Situation | Checked by | Severity | Result |
+| --- | --- | :---: | --- |
+| Same username key appears twice in one file | `check` (offline) | ❌ error | Rejected, the intent is ambiguous |
+| Same target listed twice for a user, like `[Sales_Manager, Sales_Manager]` | `check` (offline) | ⚠️ warning | Deduped |
+| A user with no scopes, or an empty list | `check` (offline) | ⚠️ warning | Ignored as a no-op |
+| Same user in two files with different targets | `check` (offline) | ✅ ok | Merged into one model, the point of slicing |
+| Declared user, permission set, group, or license missing or not unique | `validate` (online) | ❌ error | Run fails before any change |
+
 ## Modes
 
 A run performs two atomic operations: **add** missing assignments and **remove** undeclared ones. The mode selects which it actually executes. Set it with `--mode` (default `additive`):
@@ -341,6 +355,30 @@ The command surface borrows deliberately from tools you already know:
 | `ps export`     | `terraform import`     | n/a                               | n/a                          |
 | `--fail-on-drift`    | drift in plan exit code | `cfn detect-stack-drift`       | n/a                          |
 
+## Versioning
+
+Releases follow [semantic versioning](https://semver.org). You choose the bump by the git tag you create, and CI stamps and routes it to the right npm dist-tag.
+
+| Bump | When | Example tag |
+| --- | --- | --- |
+| patch | bug fix, no behavior change | `v0.1.1` |
+| minor | new backward-compatible feature | `v0.2.0` |
+| major | breaking change to a command, flag, or the YAML schema | `v1.0.0` |
+
+| dist-tag | Source | Install |
+| --- | --- | --- |
+| `latest` | a GitHub Release with a normal tag like `v1.2.0` | `sf plugins install sf-plugin-permission-sets` |
+| `next` | a Release whose tag has a hyphen, like `v1.3.0-beta.1` | `sf plugins install sf-plugin-permission-sets@next` |
+| `dev` | every push to `main`, published as `0.0.0-dev.<run>` | `sf plugins install sf-plugin-permission-sets@dev` |
+
+Cut a release with a tag off `main`:
+
+```bash
+gh release create v0.2.0 --target main --title v0.2.0 --notes "Add ps export"
+```
+
+The `next` tag is selected whenever the version contains a hyphen, not by GitHub's prerelease checkbox. The `dev` snapshots publish automatically on every push to `main`, so they need no command.
+
 ## License
 
 BSD-3-Clause © Isaac Ferreira

package/lib/commands/ps/info.d.ts

@@ -0,0 +1,11 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export type PsInfoResult = {
+    name: string;
+    description: string;
+};
+export default class Info extends SfCommand<PsInfoResult> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    run(): Promise<PsInfoResult>;
+}

package/lib/commands/ps/info.js

@@ -0,0 +1,17 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('sf-plugin-permission-sets', 'ps.info');
+export default class Info extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    async run() {
+        await this.parse(Info);
+        const name = 'sf-plugin-permission-sets';
+        const description = 'Declarative, GitOps-style management of permission set assignments.';
+        this.log(messages.getMessage('info.summary', [name, description]));
+        return { name, description };
+    }
+}
+//# sourceMappingURL=info.js.map

package/lib/commands/ps/info.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"info.js","sourceRoot":"","sources":["../../../src/commands/ps/info.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,2BAA2B,EAAE,SAAS,CAAC,CAAC;AAO/E,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,SAAuB;IAChD,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,KAAK,CAAC,GAAG;QACd,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvB,MAAM,IAAI,GAAG,2BAA2B,CAAC;QACzC,MAAM,WAAW,GAAG,qEAAqE,CAAC;QAC1F,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;QACnE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;IAC/B,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/lib/index.js

@@ -0,0 +1,2 @@
+export default {};
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,eAAe,EAAE,CAAC"}

package/messages/ps.info.md

@@ -0,0 +1,17 @@
+# summary
+
+Show information about the permission-sets plugin.
+
+# description
+
+Print the plugin name and what it does. A quick way to confirm the plugin is installed and working.
+
+# examples
+
+- Show plugin info:
+
+  <%= config.bin %> <%= command.id %>
+
+# info.summary
+
+%s - %s