@okfit/profiles 0.1.0

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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 C. Spencer Beggs
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,13 @@
1
+ # @okfit/profiles
2
+
3
+ Named configuration profiles for [okfit](https://github.com/spencerbeggs/okfit). A profile is a complete okfit config plus derivation rules. The first profile, `software-project`, describes a software repository's knowledge bundle.
4
+
5
+ > **Pre-release.** Part of the `@okfit/*` kit, in early development.
6
+
7
+ ## Status
8
+
9
+ Skeleton. The public surface is `PROFILE_NAMES` only.
10
+
11
+ ## License
12
+
13
+ [MIT](LICENSE)
package/index.d.ts ADDED
@@ -0,0 +1,21 @@
1
+ //#region src/index.d.ts
2
+ /**
3
+ * Named okfit configuration profiles.
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ /**
8
+ * Names of the profiles this package ships.
9
+ *
10
+ * @public
11
+ */
12
+ declare const PROFILE_NAMES: readonly ["software-project"];
13
+ /**
14
+ * A profile name shipped by this package.
15
+ *
16
+ * @public
17
+ */
18
+ type ProfileName = (typeof PROFILE_NAMES)[number];
19
+ //#endregion
20
+ export { PROFILE_NAMES, ProfileName };
21
+ //# sourceMappingURL=index.d.ts.map
package/index.js ADDED
@@ -0,0 +1,15 @@
1
+ //#region src/index.ts
2
+ /**
3
+ * Named okfit configuration profiles.
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ /**
8
+ * Names of the profiles this package ships.
9
+ *
10
+ * @public
11
+ */
12
+ const PROFILE_NAMES = ["software-project"];
13
+
14
+ //#endregion
15
+ export { PROFILE_NAMES };
package/package.json ADDED
@@ -0,0 +1,44 @@
1
+ {
2
+ "name": "@okfit/profiles",
3
+ "version": "0.1.0",
4
+ "private": false,
5
+ "description": "Named OKF configuration profiles for okfit, starting with the software-project profile.",
6
+ "keywords": [
7
+ "okf",
8
+ "open-knowledge-format",
9
+ "profiles",
10
+ "effect"
11
+ ],
12
+ "homepage": "https://github.com/spencerbeggs/okfit/tree/main/packages/profiles#readme",
13
+ "bugs": {
14
+ "url": "https://github.com/spencerbeggs/okfit/issues"
15
+ },
16
+ "repository": {
17
+ "type": "git",
18
+ "url": "git+https://github.com/spencerbeggs/okfit.git",
19
+ "directory": "packages/profiles"
20
+ },
21
+ "license": "MIT",
22
+ "author": {
23
+ "name": "C. Spencer Beggs",
24
+ "email": "spencer@beggs.codes",
25
+ "url": "https://spencerbeg.gs"
26
+ },
27
+ "sideEffects": false,
28
+ "type": "module",
29
+ "exports": {
30
+ ".": {
31
+ "types": "./index.d.ts",
32
+ "import": "./index.js",
33
+ "default": "./index.js"
34
+ },
35
+ "./package.json": "./package.json"
36
+ },
37
+ "dependencies": {
38
+ "@okfit/core": "0.1.0",
39
+ "effect": "4.0.0-rc.109"
40
+ },
41
+ "engines": {
42
+ "node": ">=24.11.0"
43
+ }
44
+ }
@@ -0,0 +1,11 @@
1
+ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
2
+ // It should be published with your NPM package. It should not be tracked by Git.
3
+ {
4
+ "tsdocVersion": "0.12",
5
+ "toolPackages": [
6
+ {
7
+ "packageName": "@microsoft/api-extractor",
8
+ "packageVersion": "7.59.0"
9
+ }
10
+ ]
11
+ }