Skip to content

Commit 01c8301

Browse files
authored
fix: Add proper npm package metadata and create changeset (#99)
1 parent 7b2f9a2 commit 01c8301

File tree

13 files changed

+283
-2114
lines changed

13 files changed

+283
-2114
lines changed

.changeset/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"commit": false,
55
"fixed": [],
66
"linked": [],
7-
"access": "restricted",
7+
"access": "public",
88
"baseBranch": "main",
99
"updateInternalDependencies": "patch",
1010
"ignore": ["@1fe/eslint-config", "@1fe/typescript-config"]
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
"@1fe/cli": patch
3+
"@1fe/server": patch
4+
"@1fe/shell": patch
5+
"@1fe/create-1fe-app": patch
6+
---
7+
8+
Add proper npm package metadata and fix missing license/repository info
9+
10+
- Add license, author, homepage, repository fields to all packages
11+
- Include logo assets in package files for npm display
12+
- Change access from restricted to public for better visibility
13+
14+
This fixes:
15+
- Missing npm badges on package pages
16+
- "none" license display on npmjs.com
17+
- Missing GitHub repository links
18+
- Logo not appearing on npm package pages
Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: ✨ Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "[Feature]: "
4+
labels: ["enhancement", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for your interest in improving 1fe! Please describe your feature request as clearly as possible.
10+
11+
- type: checkboxes
12+
id: prerequisites
13+
attributes:
14+
label: Prerequisites
15+
description: Please check that you've completed the following
16+
options:
17+
- label: I have searched for existing feature requests
18+
required: true
19+
- label: I have read the documentation
20+
required: true
21+
- label: This feature doesn't exist in the latest version
22+
required: true
23+
24+
- type: input
25+
id: package
26+
attributes:
27+
label: Package
28+
description: Which 1fe package would this feature affect?
29+
placeholder: "@1fe/server, @1fe/shell, @1fe/cli, @1fe/create-1fe-app, or new package"
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: problem
35+
attributes:
36+
label: Problem Statement
37+
description: What problem does this feature solve? What's the current limitation?
38+
placeholder: "I'm always frustrated when..."
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: solution
44+
attributes:
45+
label: Proposed Solution
46+
description: A clear and concise description of what you want to happen
47+
placeholder: "I would like..."
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: alternatives
53+
attributes:
54+
label: Alternatives Considered
55+
description: Any alternative solutions or features you've considered
56+
57+
- type: textarea
58+
id: benefits
59+
attributes:
60+
label: Benefits
61+
description: How would this feature benefit 1fe users?
62+
validations:
63+
required: true
64+
65+
- type: dropdown
66+
id: complexity
67+
attributes:
68+
label: Implementation Complexity
69+
description: How complex do you think this feature would be to implement?
70+
options:
71+
- Low (simple configuration or UI change)
72+
- Medium (new component or moderate logic)
73+
- High (architectural changes or new packages)
74+
- Unknown
75+
76+
- type: checkboxes
77+
id: breaking
78+
attributes:
79+
label: Breaking Changes
80+
description: Would this feature require breaking changes?
81+
options:
82+
- label: This feature would require breaking changes
83+
- label: This feature is backward compatible
84+
85+
- type: textarea
86+
id: examples
87+
attributes:
88+
label: Code Examples
89+
description: If applicable, provide code examples of how this feature would be used
90+
render: typescript
91+
92+
- type: textarea
93+
id: additional
94+
attributes:
95+
label: Additional Context
96+
description: Add any other context, mockups, or examples about the feature request here

.github/pull_request_template.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## What does this PR do?
2+
3+
<!-- Brief description of changes -->
4+
5+
## Related Issues
6+
7+
<!-- Links to issues: Closes #123, Fixes #456 -->
8+
9+
## Type of Change
10+
11+
- [ ] 🐛 Bug fix
12+
- [ ] ✨ New feature
13+
- [ ] 💥 Breaking change
14+
- [ ] 📚 Documentation
15+
- [ ] 🔧 Refactoring
16+
17+
## Checklist
18+
19+
- [ ] Code follows project standards
20+
- [ ] Self-reviewed my changes
21+
- [ ] Tests pass locally
22+
- [ ] Documentation updated (if needed)

packages/1fe-server/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# @1fe/server
44

5-
[![npm version](https://badge.fury.io/js/@1fe%2Fserver.svg)](https://www.npmjs.com/package/@1fe/server) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Join the community](https://img.shields.io/badge/Join%20the%20community-1fe.com-blue)](https://1fe.com)
5+
[![npm version](https://badge.fury.io/js/@1fe%2Fserver.svg)](https://www.npmjs.com/package/@1fe/server) [![npm downloads](https://img.shields.io/npm/dm/@1fe/server.svg)](https://www.npmjs.com/package/@1fe/server) [![CI Status](https://github.com/docusign/1fe/workflows/%F0%9F%9A%80%20CI%2FCD/badge.svg)](https://github.com/docusign/1fe/actions) [![Coverage Status](https://img.shields.io/badge/coverage-75%25-brightgreen.svg)](https://github.com/docusign/1fe) [![Bundle Size](https://img.shields.io/bundlephobia/minzip/@1fe/server)](https://bundlephobia.com/result?p=@1fe/server) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/) [![Join the community](https://img.shields.io/badge/Join%20the%20community-1fe.com-blue)](https://1fe.com)
66

77
Express server that serves as the backbone of a 1fe instance, handling dynamic configuration, widget loading, and platform services.
88

packages/1fe-server/package.json

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,23 @@
1414
"security"
1515
],
1616
"license": "MIT",
17+
"author": "DocuSign",
18+
"homepage": "https://1fe.com",
19+
"repository": {
20+
"type": "git",
21+
"url": "https://github.com/docusign/1fe.git",
22+
"directory": "packages/1fe-server"
23+
},
1724
"sideEffects": false,
1825
"files": [
19-
"dist/**"
26+
"dist/**",
27+
"assets/1fe-logo.svg"
2028
],
2129
"main": "dist/index.js",
2230
"module": "dist/index.mjs",
2331
"types": "dist/index.d.ts",
2432
"publishConfig": {
25-
"access": "restricted",
33+
"access": "public",
2634
"registry": "https://registry.npmjs.org/"
2735
},
2836
"scripts": {

packages/1fe-shell/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# @1fe/shell
44

5-
[![npm version](https://badge.fury.io/js/@1fe%2Fshell.svg)](https://www.npmjs.com/package/@1fe/shell) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Join the community](https://img.shields.io/badge/Join%20the%20community-1fe.com-blue)](https://1fe.com)
5+
[![npm version](https://badge.fury.io/js/@1fe%2Fshell.svg)](https://www.npmjs.com/package/@1fe/shell) [![npm downloads](https://img.shields.io/npm/dm/@1fe/shell.svg)](https://www.npmjs.com/package/@1fe/shell) [![CI Status](https://github.com/docusign/1fe/workflows/%F0%9F%9A%80%20CI%2FCD/badge.svg)](https://github.com/docusign/1fe/actions) [![Coverage Status](https://img.shields.io/badge/coverage-70%25-brightgreen.svg)](https://github.com/docusign/1fe) [![Bundle Size](https://img.shields.io/bundlephobia/minzip/@1fe/shell)](https://bundlephobia.com/result?p=@1fe/shell) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/) [![Join the community](https://img.shields.io/badge/Join%20the%20community-1fe.com-blue)](https://1fe.com)
66

77
Application shell providing common UI components, layout, and platform utilities for 1fe widgets.
88

packages/1fe-shell/package.json

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,23 @@
1515
"event-bus"
1616
],
1717
"license": "MIT",
18+
"author": "DocuSign",
19+
"homepage": "https://1fe.com",
20+
"repository": {
21+
"type": "git",
22+
"url": "https://github.com/docusign/1fe.git",
23+
"directory": "packages/1fe-shell"
24+
},
1825
"sideEffects": false,
1926
"files": [
20-
"dist/**"
27+
"dist/**",
28+
"assets/1fe-logo.svg"
2129
],
2230
"main": "dist/index.mjs",
2331
"module": "dist/index.mjs",
2432
"types": "dist/index.d.ts",
2533
"publishConfig": {
26-
"access": "restricted",
34+
"access": "public",
2735
"registry": "https://registry.npmjs.org/"
2836
},
2937
"scripts": {

packages/cli/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# @1fe/cli
44

5-
[![npm version](https://badge.fury.io/js/@1fe%2Fcli.svg)](https://www.npmjs.com/package/@1fe/cli) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Join the community](https://img.shields.io/badge/Join%20the%20community-1fe.com-blue)](https://1fe.com)
5+
[![npm version](https://badge.fury.io/js/@1fe%2Fcli.svg)](https://www.npmjs.com/package/@1fe/cli) [![npm downloads](https://img.shields.io/npm/dm/@1fe/cli.svg)](https://www.npmjs.com/package/@1fe/cli) [![CI Status](https://github.com/docusign/1fe/workflows/%F0%9F%9A%80%20CI%2FCD/badge.svg)](https://github.com/docusign/1fe/actions) [![Bundle Size](https://img.shields.io/bundlephobia/minzip/@1fe/cli)](https://bundlephobia.com/result?p=@1fe/cli) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/) [![Join the community](https://img.shields.io/badge/Join%20the%20community-1fe.com-blue)](https://1fe.com)
66

77
Command-line tools for building, developing, and validating widgets within the 1fe ecosystem.
88

packages/cli/package.json

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@
1414
"contracts"
1515
],
1616
"version": "0.1.2",
17+
"license": "MIT",
18+
"author": "DocuSign",
19+
"homepage": "https://1fe.com",
20+
"repository": {
21+
"type": "git",
22+
"url": "https://github.com/docusign/1fe.git",
23+
"directory": "packages/cli"
24+
},
1725
"bin": {
1826
"1fe-cli": "./dist/index.js"
1927
},
@@ -59,7 +67,8 @@
5967
"runCliAgainstWsk": "cd ../../widget-starter-kit && node ../packages/cli/dist/index.js"
6068
},
6169
"files": [
62-
"/dist"
70+
"/dist",
71+
"assets/1fe-logo.svg"
6372
],
6473
"engines": {
6574
"node": "22.13.0",
@@ -176,7 +185,7 @@
176185
"zod-validation-error": "^3.4.1"
177186
},
178187
"publishConfig": {
179-
"access": "restricted",
188+
"access": "public",
180189
"registry": "https://registry.npmjs.org/"
181190
}
182191
}

0 commit comments

Comments
 (0)