Skip to content

Commit f10a1d7

Browse files
chore: setup repository for npm publishing (#4)
- Add MIT LICENSE for OpenStaticFish - Add .npmignore to exclude dev files - Rename package to @openstaticfish/actionflow v0.1.0 - Add npm publishing metadata (bin, files, exports, engines) - Update tsconfig.json for declaration generation - Update README.md with new package name and install instructions - Update Header.tsx UI title to ACTIONFLOW - Update AGENTS.md header reference Prepares repository for publishing to npm registry
1 parent c4f0e82 commit f10a1d7

8 files changed

Lines changed: 120 additions & 15 deletions

File tree

.npmignore

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Source files (we publish compiled dist/)
2+
src/
3+
4+
# Development
5+
node_modules/
6+
.github/
7+
CLAUDE.md
8+
AGENTS.md
9+
.env
10+
.env.local
11+
12+
# Build artifacts
13+
dist/**/*.test.js
14+
dist/**/*.test.d.ts
15+
*.log
16+
17+
# IDE
18+
.vscode/
19+
.idea/
20+
*.swp
21+
*.swo
22+
23+
# Testing
24+
coverage/
25+
.nyc_output/
26+
27+
# OS
28+
.DS_Store
29+
Thumbs.db

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Agent Guidelines for workflow-automator
1+
# Agent Guidelines for ActionFlow
22

33
This document provides guidelines for AI agents working on this repository.
44

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 OpenStaticFish
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.

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Workflow Automator
1+
# ActionFlow
22

33
Interactive TUI for installing curated GitHub Actions workflows with a cyberpunk aesthetic.
44

@@ -30,8 +30,8 @@ bun run src/tui/index.tsx
3030
Or install globally:
3131

3232
```bash
33-
bun link
34-
workflow-automator
33+
bun install -g @openstaticfish/actionflow
34+
actionflow
3535
```
3636

3737
## Keyboard Shortcuts
@@ -50,7 +50,7 @@ workflow-automator
5050

5151
```
5252
┌─────────────────────────────────────────────────────────────────┐
53-
│ ⚡ WORKFLOW AUTOMATOR v1.0 Category: [opencode ▼] │
53+
│ ⚡ ACTIONFLOW v0.1.0 Category: [opencode ▼] │
5454
├──────────────────┬──────────────────────────────────────────────┤
5555
│ 🌲 Tree │ ┌─ Workflow Details ──────────────────────┐│
5656
│ ▾ pr │ │ 🔍 OpenCode AI PR Review ││

bun.lock

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 47 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,67 @@
11
{
2-
"name": "workflow-automator",
3-
"module": "src/tui/index.tsx",
4-
"type": "module",
5-
"private": true,
2+
"name": "@openstaticfish/actionflow",
3+
"version": "0.1.0",
4+
"description": "A terminal UI tool for managing and installing GitHub Actions workflow templates",
5+
"license": "MIT",
6+
"author": "OpenStaticFish <contact@openstaticfish.com>",
7+
"repository": {
8+
"type": "git",
9+
"url": "https://github.com/openstaticfish/actionflow.git"
10+
},
11+
"homepage": "https://github.com/openstaticfish/actionflow#readme",
12+
"bugs": {
13+
"url": "https://github.com/openstaticfish/actionflow/issues"
14+
},
15+
"keywords": [
16+
"github-actions",
17+
"workflow",
18+
"cli",
19+
"terminal",
20+
"tui",
21+
"automation",
22+
"ci-cd",
23+
"templates"
24+
],
25+
"module": "./dist/index.js",
26+
"types": "./dist/index.d.ts",
27+
"exports": {
28+
".": {
29+
"import": "./dist/index.js",
30+
"types": "./dist/index.d.ts"
31+
}
32+
},
633
"bin": {
7-
"workflow-automator": "./src/tui/index.tsx"
34+
"actionflow": "./dist/index.js",
35+
"af": "./dist/index.js"
36+
},
37+
"files": [
38+
"dist",
39+
"workflows",
40+
"README.md",
41+
"LICENSE"
42+
],
43+
"engines": {
44+
"bun": ">=1.0.0"
845
},
946
"scripts": {
1047
"start": "bun run src/tui/index.tsx",
1148
"build": "bun build src/tui/index.tsx --outdir=dist --target=bun",
49+
"build:types": "tsc --declaration --emitDeclarationOnly --outDir dist",
50+
"prepublishOnly": "bun run build && bun run build:types",
1251
"test": "bun test"
1352
},
1453
"devDependencies": {
1554
"@types/bun": "latest",
16-
"@types/react": "^18.2.0"
55+
"@types/react": "^18.2.0",
56+
"typescript": "^5.0.0"
1757
},
1858
"peerDependencies": {
1959
"typescript": "^5"
2060
},
2161
"dependencies": {
2262
"ink": "^5.0.0",
2363
"react": "^18.2.0",
64+
"react-devtools-core": "^7.0.1",
2465
"yaml": "^2.4.0"
2566
}
2667
}

src/tui/components/Header.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export function Header({
3636
alignItems="center"
3737
>
3838
<Text bold color={cyberpunkTheme.colors.primary}>
39-
WORKFLOW AUTOMATOR
39+
ACTIONFLOW
4040
</Text>
4141

4242
<Box marginLeft={2}>

tsconfig.json

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// Environment setup & latest features
44
"lib": ["ESNext"],
55
"target": "ESNext",
6-
"module": "Preserve",
6+
"module": "ESNext",
77
"moduleDetection": "force",
88
"jsx": "react-jsx",
99
"allowJs": true,
@@ -12,7 +12,11 @@
1212
"moduleResolution": "bundler",
1313
"allowImportingTsExtensions": true,
1414
"verbatimModuleSyntax": true,
15-
"noEmit": true,
15+
"noEmit": false,
16+
"declaration": true,
17+
"declarationMap": true,
18+
"outDir": "./dist",
19+
"rootDir": "./src",
1620

1721
// Best practices
1822
"strict": true,
@@ -25,5 +29,7 @@
2529
"noUnusedLocals": false,
2630
"noUnusedParameters": false,
2731
"noPropertyAccessFromIndexSignature": false
28-
}
32+
},
33+
"include": ["src/**/*"],
34+
"exclude": ["node_modules", "dist"]
2935
}

0 commit comments

Comments
 (0)