@napi-rs/cli 3.0.0-alpha.3 → 3.0.0-alpha.31

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.
Files changed (209) hide show
  1. package/dist/api/artifacts.js +29 -7
  2. package/dist/api/artifacts.js.map +1 -0
  3. package/dist/api/build.d.ts +1 -1
  4. package/dist/api/build.js +206 -32
  5. package/dist/api/build.js.map +1 -0
  6. package/dist/api/create-npm-dirs.js +50 -8
  7. package/dist/api/create-npm-dirs.js.map +1 -0
  8. package/dist/api/new.js +47 -20
  9. package/dist/api/new.js.map +1 -0
  10. package/dist/api/pre-publish.js +10 -7
  11. package/dist/api/pre-publish.js.map +1 -0
  12. package/dist/api/rename.js +10 -1
  13. package/dist/api/rename.js.map +1 -0
  14. package/dist/api/templates/.gitignore.d.ts +1 -1
  15. package/dist/api/templates/.gitignore.js +2 -0
  16. package/dist/api/templates/.gitignore.js.map +1 -0
  17. package/dist/api/templates/.npmignore.js +1 -0
  18. package/dist/api/templates/.npmignore.js.map +1 -0
  19. package/dist/api/templates/build.rs.js +1 -0
  20. package/dist/api/templates/build.rs.js.map +1 -0
  21. package/dist/api/templates/cargo.toml.js +1 -0
  22. package/dist/api/templates/cargo.toml.js.map +1 -0
  23. package/dist/api/templates/ci-template.d.ts +2 -1
  24. package/dist/api/templates/ci-template.js +156 -157
  25. package/dist/api/templates/ci-template.js.map +1 -0
  26. package/dist/api/templates/ci.yml.d.ts +2 -1
  27. package/dist/api/templates/ci.yml.js +19 -4
  28. package/dist/api/templates/ci.yml.js.map +1 -0
  29. package/dist/api/templates/index.js +1 -0
  30. package/dist/api/templates/index.js.map +1 -0
  31. package/dist/api/templates/js-binding.d.ts +1 -1
  32. package/dist/api/templates/js-binding.js +320 -107
  33. package/dist/api/templates/js-binding.js.map +1 -0
  34. package/dist/api/templates/lib.rs.js +2 -4
  35. package/dist/api/templates/lib.rs.js.map +1 -0
  36. package/dist/api/templates/load-wasi-template.d.ts +2 -0
  37. package/dist/api/templates/load-wasi-template.js +139 -0
  38. package/dist/api/templates/load-wasi-template.js.map +1 -0
  39. package/dist/api/templates/package.json.d.ts +9 -2
  40. package/dist/api/templates/package.json.js +55 -28
  41. package/dist/api/templates/package.json.js.map +1 -0
  42. package/dist/api/templates/wasi-worker-template.d.ts +2 -0
  43. package/dist/api/templates/wasi-worker-template.js +86 -0
  44. package/dist/api/templates/wasi-worker-template.js.map +1 -0
  45. package/dist/api/universalize.js +4 -3
  46. package/dist/api/universalize.js.map +1 -0
  47. package/dist/api/version.js +3 -2
  48. package/dist/api/version.js.map +1 -0
  49. package/dist/cli.js +1 -0
  50. package/dist/cli.js.map +1 -0
  51. package/dist/commands/artifacts.js +3 -2
  52. package/dist/commands/artifacts.js.map +1 -0
  53. package/dist/commands/build.js +2 -1
  54. package/dist/commands/build.js.map +1 -0
  55. package/dist/commands/create-npm-dirs.js +1 -0
  56. package/dist/commands/create-npm-dirs.js.map +1 -0
  57. package/dist/commands/help.js +1 -0
  58. package/dist/commands/help.js.map +1 -0
  59. package/dist/commands/new.js +15 -7
  60. package/dist/commands/new.js.map +1 -0
  61. package/dist/commands/pre-publish.js +1 -0
  62. package/dist/commands/pre-publish.js.map +1 -0
  63. package/dist/commands/rename.js +1 -0
  64. package/dist/commands/rename.js.map +1 -0
  65. package/dist/commands/universalize.js +1 -0
  66. package/dist/commands/universalize.js.map +1 -0
  67. package/dist/commands/version.js +1 -0
  68. package/dist/commands/version.js.map +1 -0
  69. package/dist/def/artifacts.d.ts +21 -1
  70. package/dist/def/artifacts.js +11 -2
  71. package/dist/def/artifacts.js.map +1 -0
  72. package/dist/def/build.d.ts +32 -2
  73. package/dist/def/build.js +23 -2
  74. package/dist/def/build.js.map +1 -0
  75. package/dist/def/create-npm-dirs.d.ts +10 -0
  76. package/dist/def/create-npm-dirs.js +5 -0
  77. package/dist/def/create-npm-dirs.js.map +1 -0
  78. package/dist/def/new.d.ts +24 -6
  79. package/dist/def/new.js +12 -1
  80. package/dist/def/new.js.map +1 -0
  81. package/dist/def/pre-publish.d.ts +10 -0
  82. package/dist/def/pre-publish.js +8 -3
  83. package/dist/def/pre-publish.js.map +1 -0
  84. package/dist/def/rename.d.ts +11 -1
  85. package/dist/def/rename.js +6 -1
  86. package/dist/def/rename.js.map +1 -0
  87. package/dist/def/universalize.d.ts +10 -0
  88. package/dist/def/universalize.js +5 -0
  89. package/dist/def/universalize.js.map +1 -0
  90. package/dist/def/version.d.ts +10 -0
  91. package/dist/def/version.js +5 -0
  92. package/dist/def/version.js.map +1 -0
  93. package/dist/index.cjs +6156 -8108
  94. package/dist/index.d.ts +1 -0
  95. package/dist/index.js +2 -0
  96. package/dist/index.js.map +1 -0
  97. package/dist/utils/__tests__/config.spec.d.ts +1 -0
  98. package/dist/utils/__tests__/config.spec.js +63 -0
  99. package/dist/utils/__tests__/config.spec.js.map +1 -0
  100. package/dist/utils/__tests__/target.spec.js +1 -0
  101. package/dist/utils/__tests__/target.spec.js.map +1 -0
  102. package/dist/utils/__tests__/typegen.spec.js +9 -4
  103. package/dist/utils/__tests__/typegen.spec.js.map +1 -0
  104. package/dist/utils/__tests__/version.spec.js +1 -0
  105. package/dist/utils/__tests__/version.spec.js.map +1 -0
  106. package/dist/utils/cargo.js +2 -1
  107. package/dist/utils/cargo.js.map +1 -0
  108. package/dist/utils/ci.js +10 -0
  109. package/dist/utils/ci.js.map +1 -0
  110. package/dist/utils/config.d.ts +24 -5
  111. package/dist/utils/config.js +39 -6
  112. package/dist/utils/config.js.map +1 -0
  113. package/dist/utils/index.js +1 -0
  114. package/dist/utils/index.js.map +1 -0
  115. package/dist/utils/log.js +1 -0
  116. package/dist/utils/log.js.map +1 -0
  117. package/dist/utils/metadata.js +3 -2
  118. package/dist/utils/metadata.js.map +1 -0
  119. package/dist/utils/misc.d.ts +1 -1
  120. package/dist/utils/misc.js +4 -3
  121. package/dist/utils/misc.js.map +1 -0
  122. package/dist/utils/target.d.ts +9 -5
  123. package/dist/utils/target.js +20 -1
  124. package/dist/utils/target.js.map +1 -0
  125. package/dist/utils/typegen.d.ts +4 -1
  126. package/dist/utils/typegen.js +27 -6
  127. package/dist/utils/typegen.js.map +1 -0
  128. package/dist/utils/version.d.ts +2 -1
  129. package/dist/utils/version.js +13 -10
  130. package/dist/utils/version.js.map +1 -0
  131. package/package.json +50 -15
  132. package/src/api/artifacts.ts +79 -9
  133. package/src/api/build.ts +331 -39
  134. package/src/api/create-npm-dirs.ts +62 -8
  135. package/src/api/new.ts +69 -33
  136. package/src/api/pre-publish.ts +21 -12
  137. package/src/api/rename.ts +10 -1
  138. package/src/api/templates/.gitignore.ts +1 -0
  139. package/src/api/templates/ci-template.ts +157 -157
  140. package/src/api/templates/ci.yml.ts +19 -4
  141. package/src/api/templates/js-binding.ts +312 -102
  142. package/src/api/templates/lib.rs.ts +1 -4
  143. package/src/api/templates/load-wasi-template.ts +146 -0
  144. package/src/api/templates/package.json.ts +78 -27
  145. package/src/api/templates/wasi-worker-template.ts +86 -0
  146. package/src/api/universalize.ts +6 -3
  147. package/src/api/version.ts +5 -2
  148. package/src/commands/artifacts.ts +2 -2
  149. package/src/commands/build.ts +1 -1
  150. package/src/commands/new.ts +14 -8
  151. package/src/def/artifacts.ts +22 -3
  152. package/src/def/build.ts +51 -4
  153. package/src/def/create-npm-dirs.ts +9 -0
  154. package/src/def/new.ts +28 -3
  155. package/src/def/pre-publish.ts +12 -3
  156. package/src/def/rename.ts +11 -2
  157. package/src/def/universalize.ts +9 -0
  158. package/src/def/version.ts +9 -0
  159. package/src/index.ts +2 -0
  160. package/src/utils/__tests__/__snapshots__/config.spec.ts.md +97 -0
  161. package/src/utils/__tests__/__snapshots__/config.spec.ts.snap +0 -0
  162. package/src/utils/__tests__/__snapshots__/target.spec.ts.md +14 -0
  163. package/src/utils/__tests__/__snapshots__/target.spec.ts.snap +0 -0
  164. package/src/utils/__tests__/__snapshots__/typegen.spec.ts.md +555 -0
  165. package/src/utils/__tests__/__snapshots__/typegen.spec.ts.snap +0 -0
  166. package/src/utils/__tests__/__snapshots__/version.spec.ts.md +9 -8
  167. package/src/utils/__tests__/__snapshots__/version.spec.ts.snap +0 -0
  168. package/src/utils/__tests__/config.spec.ts +81 -0
  169. package/src/utils/__tests__/typegen.spec.ts +19 -4
  170. package/src/utils/cargo.ts +1 -1
  171. package/src/utils/ci.ts +9 -0
  172. package/src/utils/config.ts +84 -9
  173. package/src/utils/metadata.ts +2 -2
  174. package/src/utils/misc.ts +11 -3
  175. package/src/utils/target.ts +28 -7
  176. package/src/utils/typegen.ts +30 -5
  177. package/src/utils/version.ts +11 -9
  178. package/dist/def/commands/artifacts.d.ts +0 -15
  179. package/dist/def/commands/artifacts.js +0 -29
  180. package/dist/def/commands/build.d.ts +0 -53
  181. package/dist/def/commands/build.js +0 -105
  182. package/dist/def/commands/create-npm-dirs.d.ts +0 -15
  183. package/dist/def/commands/create-npm-dirs.js +0 -29
  184. package/dist/def/commands/new.d.ts +0 -27
  185. package/dist/def/commands/new.js +0 -53
  186. package/dist/def/commands/pre-publish.d.ts +0 -23
  187. package/dist/def/commands/pre-publish.js +0 -45
  188. package/dist/def/commands/rename.d.ts +0 -25
  189. package/dist/def/commands/rename.js +0 -49
  190. package/dist/def/commands/universalize.d.ts +0 -13
  191. package/dist/def/commands/universalize.js +0 -25
  192. package/dist/def/commands/version.d.ts +0 -13
  193. package/dist/def/commands/version.js +0 -25
  194. package/dist/def/options/artifacts.d.ts +0 -35
  195. package/dist/def/options/artifacts.js +0 -11
  196. package/dist/def/options/build.d.ts +0 -97
  197. package/dist/def/options/build.js +0 -3
  198. package/dist/def/options/create-npm-dirs.d.ts +0 -35
  199. package/dist/def/options/create-npm-dirs.js +0 -11
  200. package/dist/def/options/new.d.ts +0 -79
  201. package/dist/def/options/new.js +0 -15
  202. package/dist/def/options/pre-publish.d.ts +0 -65
  203. package/dist/def/options/pre-publish.js +0 -13
  204. package/dist/def/options/rename.d.ts +0 -75
  205. package/dist/def/options/rename.js +0 -11
  206. package/dist/def/options/universalize.d.ts +0 -28
  207. package/dist/def/options/universalize.js +0 -10
  208. package/dist/def/options/version.d.ts +0 -28
  209. package/dist/def/options/version.js +0 -10
package/src/api/new.ts CHANGED
@@ -1,4 +1,4 @@
1
- import path from 'path'
1
+ import path from 'node:path'
2
2
 
3
3
  import {
4
4
  applyDefaultNewOptions,
@@ -10,7 +10,11 @@ import {
10
10
  debugFactory,
11
11
  DEFAULT_TARGETS,
12
12
  mkdirAsync,
13
+ readdirAsync,
14
+ statAsync,
15
+ type SupportedTestFramework,
13
16
  writeFileAsync,
17
+ SupportedPackageManager,
14
18
  } from '../utils/index.js'
15
19
  import { napiEngineRequirement } from '../utils/version.js'
16
20
 
@@ -35,6 +39,9 @@ type NewOptions = Required<RawNewOptions>
35
39
 
36
40
  function processOptions(options: RawNewOptions) {
37
41
  debug('Processing options...')
42
+ if (!options.path) {
43
+ throw new Error('Please provide the path as the argument')
44
+ }
38
45
  options.path = path.resolve(process.cwd(), options.path)
39
46
  debug(`Resolved target path to: ${options.path}`)
40
47
 
@@ -67,47 +74,75 @@ export async function newProject(userOptions: RawNewOptions) {
67
74
  debug('Targets to be enabled:')
68
75
  debug(options.targets)
69
76
 
70
- const outputs = generateFiles(options)
77
+ const outputs = await generateFiles(options)
71
78
 
72
- try {
73
- debug(`Try to create target directory: ${options.path}`)
74
- if (!options.dryRun) {
75
- await mkdirAsync(options.path, { recursive: true })
76
- }
77
- } catch (e) {
78
- throw new Error(`Failed to create target directory: ${options.path}`, {
79
- cause: e,
80
- })
81
- }
79
+ await ensurePath(options.path, options.dryRun)
82
80
 
83
81
  await dumpOutputs(outputs, options.dryRun)
84
82
  debug(`Project created at: ${options.path}`)
85
83
  }
86
84
 
87
- function generateFiles(options: NewOptions): Output[] {
85
+ async function ensurePath(path: string, dryRun = false) {
86
+ const stat = await statAsync(path, {}).catch(() => undefined)
87
+
88
+ // file descriptor exists
89
+ if (stat) {
90
+ if (stat.isFile()) {
91
+ throw new Error(
92
+ `Path ${path} for creating new napi-rs project already exists and it's not a directory.`,
93
+ )
94
+ } else if (stat.isDirectory()) {
95
+ const files = await readdirAsync(path)
96
+ if (files.length) {
97
+ throw new Error(
98
+ `Path ${path} for creating new napi-rs project already exists and it's not empty.`,
99
+ )
100
+ }
101
+ }
102
+ }
103
+
104
+ if (!dryRun) {
105
+ try {
106
+ debug(`Try to create target directory: ${path}`)
107
+ if (!dryRun) {
108
+ await mkdirAsync(path, { recursive: true })
109
+ }
110
+ } catch (e) {
111
+ throw new Error(`Failed to create target directory: ${path}`, {
112
+ cause: e,
113
+ })
114
+ }
115
+ }
116
+ }
117
+
118
+ async function generateFiles(options: NewOptions): Promise<Output[]> {
119
+ const packageJson = await generatePackageJson(options)
88
120
  return [
89
121
  generateCargoToml,
90
122
  generateLibRs,
91
123
  generateBuildRs,
92
- generatePackageJson,
93
124
  generateGithubWorkflow,
94
125
  generateIgnoreFiles,
95
- ].flatMap((generator) => {
96
- const output = generator(options)
97
-
98
- if (!output) {
99
- return []
100
- }
101
-
102
- if (Array.isArray(output)) {
103
- return output.map((o) => ({
104
- ...o,
105
- target: path.join(options.path, o.target),
106
- }))
107
- } else {
108
- return [{ ...output, target: path.join(options.path, output.target) }]
109
- }
110
- })
126
+ ]
127
+ .flatMap((generator) => {
128
+ const output = generator(options)
129
+
130
+ if (!output) {
131
+ return []
132
+ }
133
+
134
+ if (Array.isArray(output)) {
135
+ return output.map((o) => ({
136
+ ...o,
137
+ target: path.join(options.path, o.target),
138
+ }))
139
+ } else {
140
+ return [{ ...output, target: path.join(options.path, output.target) }]
141
+ }
142
+ })
143
+ .concat([
144
+ { ...packageJson, target: path.join(options.path, packageJson.target) },
145
+ ])
111
146
  }
112
147
 
113
148
  function generateCargoToml(options: NewOptions): Output {
@@ -136,16 +171,17 @@ function generateBuildRs(_options: NewOptions): Output {
136
171
  }
137
172
  }
138
173
 
139
- function generatePackageJson(options: NewOptions): Output {
174
+ async function generatePackageJson(options: NewOptions): Promise<Output> {
140
175
  return {
141
176
  target: './package.json',
142
- content: createPackageJson({
177
+ content: await createPackageJson({
143
178
  name: options.name,
144
179
  binaryName: getBinaryName(options.name),
145
180
  targets: options.targets,
146
181
  license: options.license,
147
182
  engineRequirement: napiEngineRequirement(options.minNodeApiVersion),
148
183
  cliVersion: CLI_VERSION,
184
+ testFramework: options.testFramework as SupportedTestFramework,
149
185
  }),
150
186
  }
151
187
  }
@@ -158,8 +194,8 @@ function generateGithubWorkflow(options: NewOptions): Output | null {
158
194
  return {
159
195
  target: './.github/workflows/ci.yml',
160
196
  content: createGithubActionsCIYml(
161
- getBinaryName(options.name),
162
197
  options.targets,
198
+ options.packageManager as SupportedPackageManager,
163
199
  ),
164
200
  }
165
201
  }
@@ -1,6 +1,6 @@
1
- import { execSync } from 'child_process'
2
- import { existsSync, statSync } from 'fs'
3
- import { join, relative, resolve } from 'path'
1
+ import { execSync } from 'node:child_process'
2
+ import { existsSync, statSync } from 'node:fs'
3
+ import { join, resolve } from 'node:path'
4
4
 
5
5
  import { Octokit } from '@octokit/rest'
6
6
 
@@ -31,10 +31,13 @@ export async function prePublish(userOptions: PrePublishOptions) {
31
31
 
32
32
  const options = applyDefaultPrePublishOptions(userOptions)
33
33
 
34
- const packageJsonPath = relative(options.cwd, options.packageJsonPath)
34
+ const packageJsonPath = resolve(options.cwd, options.packageJsonPath)
35
35
 
36
36
  const { packageJson, targets, packageName, binaryName, npmClient } =
37
- await readNapiConfig(packageJsonPath)
37
+ await readNapiConfig(
38
+ packageJsonPath,
39
+ options.configPath ? resolve(options.cwd, options.configPath) : undefined,
40
+ )
38
41
 
39
42
  async function createGhRelease(packageName: string, version: string) {
40
43
  if (!options.ghRelease) {
@@ -129,11 +132,14 @@ export async function prePublish(userOptions: PrePublishOptions) {
129
132
  if (!options.dryRun) {
130
133
  await version(userOptions)
131
134
  await updatePackageJson(packageJsonPath, {
132
- optionalDependencies: targets.reduce((deps, target) => {
133
- deps[`${packageName}-${target.platformArchABI}`] = packageJson.version
134
-
135
- return deps
136
- }, {} as Record<string, string>),
135
+ optionalDependencies: targets.reduce(
136
+ (deps, target) => {
137
+ deps[`${packageName}-${target.platformArchABI}`] = packageJson.version
138
+
139
+ return deps
140
+ },
141
+ {} as Record<string, string>,
142
+ ),
137
143
  })
138
144
  }
139
145
 
@@ -147,7 +153,9 @@ export async function prePublish(userOptions: PrePublishOptions) {
147
153
  options.npmDir,
148
154
  `${target.platformArchABI}`,
149
155
  )
150
- const filename = `${binaryName}.${target.platformArchABI}.node`
156
+ const ext =
157
+ target.platform === 'wasi' || target.platform === 'wasm' ? 'wasm' : 'node'
158
+ const filename = `${binaryName}.${target.platformArchABI}.${ext}`
151
159
  const dstPath = join(pkgDir, filename)
152
160
 
153
161
  if (!options.dryRun) {
@@ -184,7 +192,8 @@ export async function prePublish(userOptions: PrePublishOptions) {
184
192
  'content-length': dstFileStats.size,
185
193
  'content-type': 'application/octet-stream',
186
194
  },
187
- data: await readFileAsync(dstPath, { encoding: 'utf-8' }),
195
+ // @ts-expect-error octokit types are wrong
196
+ data: await readFileAsync(dstPath),
188
197
  })
189
198
  debug.info(`GitHub release created`)
190
199
  debug.info(`Download URL: %s`, assetInfo.data.browser_download_url)
package/src/api/rename.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { resolve } from 'path'
1
+ import { resolve } from 'node:path'
2
2
 
3
3
  import { isNil, merge, omitBy, pick } from 'lodash-es'
4
4
 
@@ -30,6 +30,15 @@ export async function renameProject(userOptions: RenameOptions) {
30
30
  },
31
31
  )
32
32
 
33
+ if (options.configPath) {
34
+ const configPath = resolve(options.cwd, options.configPath)
35
+ const configContent = await readFileAsync(configPath, 'utf8')
36
+ const configData = JSON.parse(configContent)
37
+ configData.binaryName = options.binaryName
38
+ configData.packageName = options.packageName
39
+ await writeFileAsync(configPath, JSON.stringify(configData, null, 2))
40
+ }
41
+
33
42
  await writeFileAsync(
34
43
  packageJsonPath,
35
44
  JSON.stringify(packageJsonData, null, 2),
@@ -195,4 +195,5 @@ Cargo.lock
195
195
  !.yarn/versions
196
196
 
197
197
  *.node
198
+ *.wasm
198
199
  `