@shipsafe/cli 0.2.2 → 0.2.4
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/dist/src/cli/init.d.ts.map +1 -1
- package/dist/src/cli/init.js +103 -15
- package/dist/src/cli/init.js.map +1 -1
- package/package.json +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../src/cli/init.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../src/cli/init.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAOpC,MAAM,WAAW,WAAW;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AA2FD;;;GAGG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAsC1E;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAU1D"}
|
package/dist/src/cli/init.js
CHANGED
|
@@ -1,7 +1,86 @@
|
|
|
1
1
|
import { randomUUID } from 'node:crypto';
|
|
2
|
+
import * as fs from 'node:fs/promises';
|
|
3
|
+
import * as path from 'node:path';
|
|
4
|
+
import { execFile } from 'node:child_process';
|
|
5
|
+
import { promisify } from 'node:util';
|
|
2
6
|
import chalk from 'chalk';
|
|
3
7
|
import { loadProjectConfig, saveProjectConfig } from '../config/manager.js';
|
|
4
8
|
import { handleSetupAction } from './setup.js';
|
|
9
|
+
const execFileAsync = promisify(execFile);
|
|
10
|
+
const SHIPSAFE_AI_INSTRUCTION = `
|
|
11
|
+
# ShipSafe Security
|
|
12
|
+
|
|
13
|
+
This project uses ShipSafe for security scanning. When the shipsafe MCP tools are available:
|
|
14
|
+
|
|
15
|
+
1. Run shipsafe_scan at the start of every task to check for security issues
|
|
16
|
+
2. After writing or modifying code, run shipsafe_scan to verify no vulnerabilities were introduced
|
|
17
|
+
3. Before completing any task, confirm the security score is passing
|
|
18
|
+
4. If findings are reported, explain them to the user and suggest fixes
|
|
19
|
+
5. Use shipsafe_check_package before recommending new dependencies
|
|
20
|
+
`.trim();
|
|
21
|
+
const AI_CONFIG_FILES = [
|
|
22
|
+
{ filename: 'CLAUDE.md', tool: 'Claude Code' },
|
|
23
|
+
{ filename: '.cursorrules', tool: 'Cursor' },
|
|
24
|
+
{ filename: '.windsurfrules', tool: 'Windsurf' },
|
|
25
|
+
{ filename: '.github/copilot-instructions.md', tool: 'GitHub Copilot' },
|
|
26
|
+
{ filename: '.clinerules', tool: 'Cline' },
|
|
27
|
+
];
|
|
28
|
+
async function registerMCPServers() {
|
|
29
|
+
const registered = [];
|
|
30
|
+
const shipsafePath = process.argv[1]?.replace(/\/bin\/shipsafe\.(js|ts)$/, '/bin/shipsafe.js')
|
|
31
|
+
|| '/usr/local/bin/shipsafe';
|
|
32
|
+
// Try to find the actual shipsafe binary
|
|
33
|
+
let binPath = '/usr/local/bin/shipsafe';
|
|
34
|
+
try {
|
|
35
|
+
const { stdout } = await execFileAsync('which', ['shipsafe']);
|
|
36
|
+
binPath = stdout.trim();
|
|
37
|
+
}
|
|
38
|
+
catch {
|
|
39
|
+
// Fall back to default
|
|
40
|
+
}
|
|
41
|
+
// Register with Claude Code
|
|
42
|
+
try {
|
|
43
|
+
await execFileAsync('claude', ['mcp', 'add', 'shipsafe', binPath, 'mcp-server']);
|
|
44
|
+
registered.push('Claude Code');
|
|
45
|
+
}
|
|
46
|
+
catch {
|
|
47
|
+
// Claude CLI not installed — skip silently
|
|
48
|
+
}
|
|
49
|
+
return registered;
|
|
50
|
+
}
|
|
51
|
+
async function writeAIConfigs(projectDir) {
|
|
52
|
+
const dir = projectDir ?? process.cwd();
|
|
53
|
+
const written = [];
|
|
54
|
+
for (const config of AI_CONFIG_FILES) {
|
|
55
|
+
const filePath = path.join(dir, config.filename);
|
|
56
|
+
// Create parent directory if needed (for .github/copilot-instructions.md)
|
|
57
|
+
const parentDir = path.dirname(filePath);
|
|
58
|
+
await fs.mkdir(parentDir, { recursive: true });
|
|
59
|
+
try {
|
|
60
|
+
// Check if file exists and already has ShipSafe section
|
|
61
|
+
let existing = '';
|
|
62
|
+
try {
|
|
63
|
+
existing = await fs.readFile(filePath, 'utf-8');
|
|
64
|
+
}
|
|
65
|
+
catch {
|
|
66
|
+
// File doesn't exist — that's fine
|
|
67
|
+
}
|
|
68
|
+
if (existing.includes('ShipSafe Security')) {
|
|
69
|
+
continue; // Already configured
|
|
70
|
+
}
|
|
71
|
+
// Append to existing content or create new
|
|
72
|
+
const content = existing
|
|
73
|
+
? existing.trimEnd() + '\n\n' + SHIPSAFE_AI_INSTRUCTION + '\n'
|
|
74
|
+
: SHIPSAFE_AI_INSTRUCTION + '\n';
|
|
75
|
+
await fs.writeFile(filePath, content, 'utf-8');
|
|
76
|
+
written.push(config.tool);
|
|
77
|
+
}
|
|
78
|
+
catch {
|
|
79
|
+
// Skip files we can't write
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
return written;
|
|
83
|
+
}
|
|
5
84
|
/**
|
|
6
85
|
* Main init action — bootstraps a project with a project ID, config file,
|
|
7
86
|
* and optional setup (hooks, MCP, CLAUDE.md).
|
|
@@ -10,26 +89,35 @@ export async function handleInitAction(options) {
|
|
|
10
89
|
const { projectDir, skipSetup = false } = options;
|
|
11
90
|
// Load existing config to check for an existing projectId
|
|
12
91
|
const existingConfig = await loadProjectConfig(projectDir);
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
92
|
+
let projectId = existingConfig.projectId;
|
|
93
|
+
if (projectId) {
|
|
94
|
+
console.log(chalk.dim(' Project already initialized (projectId: ' + projectId + ')'));
|
|
95
|
+
}
|
|
96
|
+
else {
|
|
97
|
+
projectId = `proj_${randomUUID().slice(0, 12)}`;
|
|
98
|
+
await saveProjectConfig({ projectId }, projectDir);
|
|
99
|
+
console.log(chalk.green('✓') + ` Created shipsafe.config.json (projectId: ${projectId})`);
|
|
100
|
+
}
|
|
101
|
+
// Write AI assistant config files
|
|
102
|
+
const aiTools = await writeAIConfigs(projectDir ?? process.cwd());
|
|
103
|
+
if (aiTools.length > 0) {
|
|
104
|
+
console.log(chalk.green('✓') + ` AI security rules added for: ${aiTools.join(', ')}`);
|
|
105
|
+
}
|
|
106
|
+
// Register MCP server with AI coding tools
|
|
107
|
+
const mcpTools = await registerMCPServers();
|
|
108
|
+
if (mcpTools.length > 0) {
|
|
109
|
+
console.log(chalk.green('✓') + ` MCP server registered for: ${mcpTools.join(', ')}`);
|
|
110
|
+
}
|
|
23
111
|
// Run setup unless explicitly skipped
|
|
24
112
|
if (!skipSetup) {
|
|
25
113
|
await handleSetupAction({});
|
|
26
114
|
}
|
|
27
|
-
// Print getting-started instructions
|
|
28
115
|
console.log('');
|
|
29
|
-
console.log(chalk.bold('ShipSafe
|
|
30
|
-
console.log('
|
|
31
|
-
console.log('
|
|
32
|
-
console.log('
|
|
116
|
+
console.log(chalk.green.bold(' ShipSafe is ready.'));
|
|
117
|
+
console.log('');
|
|
118
|
+
console.log(' Your AI assistant will now auto-scan for security issues.');
|
|
119
|
+
console.log(' Run ' + chalk.cyan('shipsafe scan') + ' anytime for a manual scan.');
|
|
120
|
+
console.log('');
|
|
33
121
|
}
|
|
34
122
|
export function registerInitCommand(program) {
|
|
35
123
|
program
|
package/dist/src/cli/init.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../src/cli/init.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../src/cli/init.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAE/C,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;AAO1C,MAAM,uBAAuB,GAAG;;;;;;;;;;CAU/B,CAAC,IAAI,EAAE,CAAC;AAET,MAAM,eAAe,GAKhB;IACH,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,aAAa,EAAE;IAC9C,EAAE,QAAQ,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE;IAC5C,EAAE,QAAQ,EAAE,gBAAgB,EAAE,IAAI,EAAE,UAAU,EAAE;IAChD,EAAE,QAAQ,EAAE,iCAAiC,EAAE,IAAI,EAAE,gBAAgB,EAAE;IACvE,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,OAAO,EAAE;CAC3C,CAAC;AAEF,KAAK,UAAU,kBAAkB;IAC/B,MAAM,UAAU,GAAa,EAAE,CAAC;IAChC,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,2BAA2B,EAAE,kBAAkB,CAAC;WACzF,yBAAyB,CAAC;IAE/B,yCAAyC;IACzC,IAAI,OAAO,GAAG,yBAAyB,CAAC;IACxC,IAAI,CAAC;QACH,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,aAAa,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;QAC9D,OAAO,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,uBAAuB;IACzB,CAAC;IAED,4BAA4B;IAC5B,IAAI,CAAC;QACH,MAAM,aAAa,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;QACjF,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACjC,CAAC;IAAC,MAAM,CAAC;QACP,2CAA2C;IAC7C,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,UAAkB;IAC9C,MAAM,GAAG,GAAG,UAAU,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IACxC,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,KAAK,MAAM,MAAM,IAAI,eAAe,EAAE,CAAC;QACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QAEjD,0EAA0E;QAC1E,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACzC,MAAM,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAE/C,IAAI,CAAC;YACH,wDAAwD;YACxD,IAAI,QAAQ,GAAG,EAAE,CAAC;YAClB,IAAI,CAAC;gBACH,QAAQ,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAClD,CAAC;YAAC,MAAM,CAAC;gBACP,mCAAmC;YACrC,CAAC;YAED,IAAI,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC;gBAC3C,SAAS,CAAC,qBAAqB;YACjC,CAAC;YAED,2CAA2C;YAC3C,MAAM,OAAO,GAAG,QAAQ;gBACtB,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,MAAM,GAAG,uBAAuB,GAAG,IAAI;gBAC9D,CAAC,CAAC,uBAAuB,GAAG,IAAI,CAAC;YAEnC,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YAC/C,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;QAAC,MAAM,CAAC;YACP,4BAA4B;QAC9B,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,OAAoB;IACzD,MAAM,EAAE,UAAU,EAAE,SAAS,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;IAElD,0DAA0D;IAC1D,MAAM,cAAc,GAAG,MAAM,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAE3D,IAAI,SAAS,GAAG,cAAc,CAAC,SAAS,CAAC;IACzC,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,4CAA4C,GAAG,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC;IACzF,CAAC;SAAM,CAAC;QACN,SAAS,GAAG,QAAQ,UAAU,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC;QAChD,MAAM,iBAAiB,CAAC,EAAE,SAAS,EAAE,EAAE,UAAU,CAAC,CAAC;QACnD,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,6CAA6C,SAAS,GAAG,CAAC,CAAC;IAC5F,CAAC;IAED,kCAAkC;IAClC,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,UAAU,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAClE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,iCAAiC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACxF,CAAC;IAED,2CAA2C;IAC3C,MAAM,QAAQ,GAAG,MAAM,kBAAkB,EAAE,CAAC;IAC5C,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,+BAA+B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACvF,CAAC;IAED,sCAAsC;IACtC,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,iBAAiB,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC;IACtD,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChB,OAAO,CAAC,GAAG,CAAC,6DAA6D,CAAC,CAAC;IAC3E,OAAO,CAAC,GAAG,CAAC,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,6BAA6B,CAAC,CAAC;IACpF,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,OAAgB;IAClD,OAAO;SACJ,OAAO,CAAC,MAAM,CAAC;SACf,WAAW,CAAC,6CAA6C,CAAC;SAC1D,MAAM,CAAC,cAAc,EAAE,sCAAsC,CAAC;SAC9D,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QACxB,MAAM,gBAAgB,CAAC;YACrB,SAAS,EAAE,OAAO,CAAC,SAAS;SAC7B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC"}
|