extension-create 2.0.0-alpha.0 → 2.0.0-alpha.10
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/README.md +8 -6
- package/dist/module.d.ts +2 -2
- package/dist/module.js +17 -16
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# extension-create
|
|
2
2
|
|
|
3
3
|
> The **create** part of [Extension.js](https://github.com/cezaraugusto/extension). Available as a standalone package.
|
|
4
4
|
|
|
@@ -7,19 +7,21 @@ This package stores all logic needed by Extension.js to create new projects.
|
|
|
7
7
|
## Installation
|
|
8
8
|
|
|
9
9
|
```
|
|
10
|
-
yarn add
|
|
10
|
+
yarn add extension-create
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
## Usage
|
|
14
14
|
|
|
15
15
|
```js
|
|
16
|
-
import
|
|
16
|
+
import {extensionCreate} from 'extension-create'
|
|
17
17
|
|
|
18
18
|
async function createNewExtension () {
|
|
19
|
-
await
|
|
19
|
+
await extensionCreate(
|
|
20
20
|
projectName: /* string (required) */,
|
|
21
|
-
|
|
22
|
-
|
|
21
|
+
{
|
|
22
|
+
/* string - Template name or URL. Defaults to 'init' */
|
|
23
|
+
template
|
|
24
|
+
}
|
|
23
25
|
)
|
|
24
26
|
}
|
|
25
27
|
|
package/dist/module.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
interface CreateOptions {
|
|
2
2
|
template: string;
|
|
3
|
-
|
|
3
|
+
install?: boolean;
|
|
4
4
|
}
|
|
5
|
-
declare function extensionCreate(projectNameInput: string | undefined, { template,
|
|
5
|
+
declare function extensionCreate(projectNameInput: string | undefined, { template, install }: CreateOptions): Promise<void>;
|
|
6
6
|
|
|
7
7
|
export { type CreateOptions, extensionCreate };
|
package/dist/module.js
CHANGED
|
@@ -1,25 +1,26 @@
|
|
|
1
|
-
"use strict";var
|
|
1
|
+
"use strict";var Le=Object.create;var k=Object.defineProperty;var Ve=Object.getOwnPropertyDescriptor;var Xe=Object.getOwnPropertyNames;var Ue=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var qe=(e,t)=>{for(var r in t)k(e,r,{get:t[r],enumerable:!0})},j=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let i of Xe(t))!Ye.call(e,i)&&i!==r&&k(e,i,{get:()=>t[i],enumerable:!(n=Ve(t,i))||n.enumerable});return e};var c=(e,t,r)=>(r=e!=null?Le(Ue(e)):{},j(t||!e||!e.__esModule?k(r,"default",{value:e,enumerable:!0}):r,e)),He=e=>j(k({},"__esModule",{value:!0}),e);var lt={};qe(lt,{extensionCreate:()=>ct});module.exports=He(lt);var C=c(require("path"));var y=c(require("path")),o=require("@colors/colors/safe"),G=c(require("fs/promises")),A=require("detect-package-manager");function O(e){let t=y.default.basename(e);return`Failed to write in the destination directory. Path for \`${t}\` is not writable.
|
|
2
2
|
Ensure you have write permissions for this folder.
|
|
3
|
-
Path: ${t}`}async function
|
|
4
|
-
Conflict! Path to ${(0,
|
|
3
|
+
Path: ${t}`}async function W(e,t){let r=y.default.basename(e),n=`
|
|
4
|
+
Conflict! Path to ${(0,o.cyan)(r)} includes conflicting files:
|
|
5
5
|
|
|
6
|
-
`;for(let
|
|
7
|
-
`:`${(0,
|
|
8
|
-
`}return
|
|
6
|
+
`;for(let i of t){let s=await G.default.lstat(y.default.join(e,i));n+=s.isDirectory()?`${(0,o.gray)("-")} ${(0,o.brightYellow)(i)}
|
|
7
|
+
`:`${(0,o.gray)("-")} ${(0,o.brightYellow)(i)}
|
|
8
|
+
`}return n+=`
|
|
9
9
|
You need to either rename/remove the files listed above, or choose a new directory name for your extension.
|
|
10
10
|
|
|
11
|
-
Path to conflicting directory: ${(0,
|
|
11
|
+
Path to conflicting directory: ${(0,o.underline)(e)}`,n}function z(){return"You need to provide an extension name to create one. \nSee `--help` for command info."}function L(){return"URLs are not allowed as a project path. Either write a name or a path to a local folder."}async function V(e,t){let r=y.default.relative(process.cwd(),e),n=process.env._||"",i=await(0,A.detect)(),s=n.split(y.default.sep).pop()?.toLowerCase()||i,a="npm run";switch(s){case"yarn":a="yarn dev";break;case"pnpm":a="pnpm dev";break;default:a="npm run dev"}return`\u{1F9E9} - ${(0,o.brightGreen)("Success!")} Extension ${(0,o.cyan)(t)} created.
|
|
12
12
|
|
|
13
|
-
Now ${(0,
|
|
13
|
+
Now ${(0,o.brightBlue)(`cd ${(0,o.underline)(r)}`)} and ${(0,o.brightBlue)(`${a}`)} to open a new browser instance
|
|
14
14
|
with your extension installed, loaded, and enabled for development.
|
|
15
15
|
|
|
16
|
-
${(0,
|
|
17
|
-
// This file auto-generated and should not be excluded.
|
|
18
|
-
// If you need
|
|
19
|
-
// referencing it in the "include" array
|
|
20
|
-
// See https://www.typescriptlang.org/tsconfig#include for
|
|
21
|
-
/// <reference types="${
|
|
16
|
+
${(0,o.brightGreen)("You are ready")}. Time to hack on your extension!`}function X(e){return`\u{1F423} - Starting a new browser extension named ${(0,o.cyan)(e)}...`}function U(){return"\u{1F91E} - Checking if destination path is writeable..."}function Y(){return"\u{1F50E} - Scanning for potential conflicting files..."}function q(e,t){return`${(0,o.red)("\u2716\uFE0E\u2716\uFE0E\u2716\uFE0E")} Can't create directory ${(0,o.cyan)(e)}. ${t}`}function H(e){return`\u{1F537} - Writing ${(0,o.cyan)(e)} type definitions...`}function B(e){return`${(0,o.red)("\u2716\uFE0E\u2716\uFE0E\u2716\uFE0E")} Failed to write the extension type definition. ${e}`}function E(e,t){return t==="init"?`\u{1F9F0} - Installing ${(0,o.cyan)(e)}...`:`\u{1F9F0} - Installing ${(0,o.cyan)(e)} from template ${(0,o.brightBlue)(t)}...`}function b(e,t,r){return`${(0,o.red)("\u2716\uFE0E\u2716\uFE0E\u2716\uFE0E")} Can't find template ${(0,o.brightBlue)(t)} for ${(0,o.cyan)(e)}. ${r}`}function K(e){return`\u{1F332} - Initializing git repository for ${(0,o.cyan)(e)}...`}function Q(e,t,r){return`Command ${e} ${t.join(" ")} failed with exit code ${r}`}function Z(e,t){return`${(0,o.red)("\u2716\uFE0E\u2716\uFE0E\u2716\uFE0E")} Child process error: Can't initialize ${(0,o.brightYellow)("git")} for ${(0,o.cyan)(e)}. ${t.message}`}function ee(e,t){return`${(0,o.red)("\u2716\uFE0E\u2716\uFE0E\u2716\uFE0E")} Can't initialize ${(0,o.brightYellow)("git")} for ${(0,o.cyan)(e)}. ${t.message||t.toString()}`}function te(){return"\u{1F6E0} - Installing dependencies... (takes a moment)"}function ne(e,t,r){return`Command ${e} ${t.join(" ")} failed with exit code ${r}`}function ie(e,t){return`${(0,o.red)("\u2716\uFE0E\u2716\uFE0E\u2716\uFE0E")} Child process error: Can't install dependencies for ${(0,o.cyan)(e)}. ${t}`}function re(e,t){return`${(0,o.red)("\u2716\uFE0E\u2716\uFE0E\u2716\uFE0E")} Can't install dependencies for ${(0,o.cyan)(e)}. ${t.message||t.toString()}`}function oe(){return"Symlink created successfully."}function se(e,t){return`Failed to create symlink: ${e} ${t.join(" ")}`}function ae(){return`\u{1F4DD} - Writing ${(0,o.brightYellow)("package.json")} metadata...`}function ce(e,t){return`${(0,o.red)("\u2716\uFE0E\u2716\uFE0E\u2716\uFE0E")} Can't write ${(0,o.brightYellow)("package.json")} for ${(0,o.cyan)(e)}. ${t}`}function le(){return`\u{1F4DC} - Writing ${(0,o.brightYellow)("manifest.json")} metadata...`}function me(e,t){return`${(0,o.red)("\u2716\uFE0E\u2716\uFE0E\u2716\uFE0E")} Can't write ${(0,o.brightYellow)("manifest.json")} for ${(0,o.cyan)(e)}. ${t}`}function pe(){return`\u{1F4C4} - Writing ${(0,o.brightYellow)("README.md")} metadata...`}function ge(){return`\u{1F648} - Writing ${(0,o.brightYellow)(".gitignore")} lines...`}function de(e,t){return`${(0,o.red)("\u2716\uFE0E\u2716\uFE0E\u2716\uFE0E")} Can't write the ${(0,o.brightYellow)("README.md")} file for ${(0,o.cyan)(e)}. ${t}`}function fe(e){return`\u{1F91D} - Ensuring ${(0,o.cyan)(e)} folder exists...`}function ue(e){return"Error while checking directory writability: "+e}var $=c(require("fs/promises")),x=c(require("path")),we=require("detect-package-manager");async function P(e,t){let r=await $.default.readdir(e,{withFileTypes:!0});return await $.default.mkdir(t,{recursive:!0}),await Promise.all(r.map(async n=>{let i=x.default.join(e,n.name),s=x.default.join(t,n.name);n.isDirectory()?await P(i,s):await $.default.copyFile(i,s)}))}async function h(){let e=process.env._||"",t=await(0,we.detect)(),r=e.split(x.default.sep).pop()?.toLowerCase()||t,n="npm";switch(r){case"yarn":n="yarn";break;case"pnpm":n="pnpm";break;default:n="npm"}return n}function ye(e){let t=x.default.resolve(__dirname,"template");return x.default.resolve(e,t)}async function xe(e,t){try{return console.log(fe(t)),await $.default.mkdir(e,{recursive:!0}),!0}catch(r){return console.log(ue(r)),!1}}function he(e){return e!=="init"}function Ee(e){return e.includes("typescript")||e.includes("react")||e.includes("preact")||e.includes("svelte")||e.includes("solid")}var $e=c(require("path")),S=c(require("fs/promises"));var Be=["LICENSE","node_modules"];async function ve(e,t){console.log(X(t));try{let r=await xe(e,t);console.log(U()),r||(console.error(O(e)),process.exit(1));let n=await S.default.readdir(e);console.log(Y());let i=await Promise.all(n.filter(s=>!s.startsWith(".")).filter(s=>!s.endsWith(".log")).filter(s=>!Be.includes(s)).map(async s=>(await S.default.lstat($e.default.join(e,s))).isDirectory()?`${s}/`:`${s}`));if(i.length>0){let s=await W(e,i);throw new Error(s)}}catch(r){console.error(q(t,r)),process.exit(1)}}var ke=c(require("path"));async function be(e,t,r){let n=ke.default.resolve(__dirname,"template");try{console.log(E(t,r)),await P(n,e)}catch(i){console.error(b(t,r,i)),process.exit(1)}}var p=c(require("path")),f=c(require("fs/promises")),De=c(require("go-git-it"));async function Fe(e,t,r){let n=p.default.dirname(e),i=p.default.basename(r),a=`https://github.com/extension-js/extension.js/tree/main/examples/${r}`;try{await f.default.mkdir(e,{recursive:!0});let l="";if(process.env.EXTENSION_ENV==="development"?(console.log(E(t,r)),l=p.default.join(e,i),await f.default.cp(p.default.join(__dirname,"..","..","..","examples",i),l,{recursive:!0})):(await(0,De.default)(a,n,E(t,i)),l=p.default.join(n,i)),t!==i){let m=p.default.join(n,t);await f.default.mkdir(m,{recursive:!0});let g=await f.default.readdir(l);for(let u of g)await f.default.rename(p.default.join(l,u),p.default.join(m,u));await f.default.rm(l,{recursive:!0,force:!0})}else{let m=p.default.join(n,t+"-temp");await f.default.rename(l,m);let g=p.default.join(m,i),u=p.default.join(n,t);await f.default.mkdir(u,{recursive:!0});let ze=await f.default.readdir(g);for(let N of ze)await f.default.rename(p.default.join(g,N),p.default.join(u,N));await f.default.rm(m,{recursive:!0,force:!0})}}catch(l){console.error(b(t,i,l)),process.exit(1)}}var v=c(require("path")),I=c(require("fs/promises"));var Ke={dev:process.env.EXTENSION_ENV==="development"?"node node_modules/extension dev":"extension dev",start:process.env.EXTENSION_ENV==="development"?"node node_modules/extension start":"extension start",build:process.env.EXTENSION_ENV==="development"?"node node_modules/extension build":"extension build"};async function Te(e,t,r){let n=ye(process.cwd()),i=he(r)?v.default.join(e,"package.json"):v.default.join(n,"package.json"),s=await I.default.readFile(i),a=JSON.parse(s.toString());a.scripts=a.scripts||{},a.dependencies=a.dependencies||{},a.devDependencies={...a.devDependencies||{},extension:process.env.EXTENSION_ENV==="development"?"*":"latest"};let l={...a,name:v.default.basename(e),private:!0,scripts:{...a.scripts,...Ke},dependencies:a.dependencies,devDependencies:a.devDependencies,author:{name:"Your Name",email:"your@email.com",url:"https://yourwebsite.com"}};try{console.log(ae()),await I.default.writeFile(v.default.join(e,"package.json"),JSON.stringify(l,null,2))}catch(m){console.error(ce(t,m)),process.exit(1)}}var Se=c(require("path")),Ie=require("cross-spawn"),Je=c(require("fs"));var Ce=c(require("path")),J=require("cross-spawn");async function Pe(e){let t=Ce.default.join(__dirname,"../../cli"),r=await h(),n=["link"];await new Promise((i,s)=>{(0,J.spawn)(r,n,{cwd:t}).on("close",()=>{(0,J.spawn)(r,[...n,"extension"],{stdio:"inherit",cwd:e}).on("close",m=>{m===0?(console.log(oe()),i()):s(new Error(se(r,n)))})})}),console.log("Symlink creation completed.")}function Qe(){return["install","--silent"]}async function Me(e,t){let r=Se.default.join(e,"node_modules"),n=await h(),i=Qe();console.log(te()),process.env.EXTENSION_ENV==="development"&&await Pe(e);try{let s=process.cwd();process.chdir(e),await Je.default.promises.mkdir(r,{recursive:!0});let a=process.env.EXTENSION_ENV==="development"?"inherit":"ignore",l=(0,Ie.spawn)(n,i,{stdio:a});await new Promise((m,g)=>{l.on("close",u=>{process.chdir(s),u!==0?g(new Error(ne(n,i,u))):m()}),l.on("error",u=>{process.chdir(s),console.error(ie(t,u)),g(u)})})}catch(s){console.error(re(t,s)),process.exit(1)}}var D=c(require("path")),F=c(require("fs/promises"));async function _e(e,t){let r=await F.default.readFile(D.default.join(__dirname,"template","README.md"),"utf-8"),n=await h(),i=require(D.default.join(e,"manifest.json")),s=r.replaceAll("[projectName]",t).replaceAll("[templateDescription]",i.description).replaceAll("[runCommand]",n);try{console.log(pe()),await F.default.mkdir(e,{recursive:!0}),await F.default.writeFile(D.default.join(e,"README.md"),s)}catch(a){console.error(de(t,a)),process.exit(1)}}var T=c(require("path")),M=c(require("fs/promises"));async function Re(e,t){let r=T.default.join(e,"manifest.json"),n=await M.default.readFile(r),s={...JSON.parse(n.toString()),name:T.default.basename(e),author:"Your Name"};try{console.log(le()),await M.default.writeFile(T.default.join(e,"manifest.json"),JSON.stringify(s,null,2))}catch(a){console.error(me(t,a)),process.exit(1)}}var _=c(require("path")),R=c(require("fs/promises"));async function Ne(e,t){let r=_.default.join(e,"extension-env.d.ts"),n=process.env.EXTENSION_ENV==="development"?_.default.resolve(process.cwd(),"programs/cli/types"):"extension/dist/types",i=`// Required Extension.js types for TypeScript projects.
|
|
17
|
+
// This file is auto-generated and should not be excluded.
|
|
18
|
+
// If you need additional types, consider creating a new *.d.ts file and
|
|
19
|
+
// referencing it in the "include" array of your tsconfig.json file.
|
|
20
|
+
// See https://www.typescriptlang.org/tsconfig#include for more information.
|
|
21
|
+
/// <reference types="${n}/index.d.ts" />
|
|
22
22
|
|
|
23
23
|
// Polyfill types for browser.* APIs.
|
|
24
|
-
/// <reference types="${
|
|
25
|
-
`;try{await R.default.mkdir(e,{recursive:!0}),console.log(H(t)),await R.default.writeFile(i
|
|
24
|
+
/// <reference types="${n}/polyfill.d.ts" />
|
|
25
|
+
`;try{await R.default.mkdir(e,{recursive:!0}),console.log(H(t)),await R.default.writeFile(r,i)}catch(s){console.error(B(s)),process.exit(1)}}var je=c(require("fs/promises")),Ge=c(require("path"));var Ze=["","# dependencies","node_modules"],et=["","# testing","coverage"],tt=["","# production","dist"],nt=["","# misc",".DS_Store"],it=["","# local env files",".env.local",".env.development.local",".env.test.local",".env.production.local"],rt=["","# debug files","npm-debug.log*","yarn-debug.log*","yarn-error.log*"],ot=["","# lock files","yarn.lock","package-lock.json"],st=["","# extension.js","extension-env.d.ts"],at=["# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.",...Ze,...et,...tt,...nt,...it,...ot,...rt,...st];async function Ae(e){let t=Ge.default.join(e,".gitignore"),r=await je.default.open(t,"a+").catch(s=>{console.error(s),process.exit(1)}),n=new Set;for await(let s of r.readLines({autoClose:!1}))s=s.trim(),s.length!==0&&n.add(s);let i=at.filter(s=>!n.has(s));for(;i[i.length-1]==="";)i.pop();console.log(ge()),await r.appendFile(i.join(`
|
|
26
|
+
`),{flush:!0}).catch(s=>{console.error(s),process.exit(1)})}var Oe=require("cross-spawn");async function We(e,t){let r="git",n=["init","--quiet"];console.log(K(t));try{let i=process.cwd();process.chdir(e);let s=process.env.EXTENSION_ENV==="development"?"inherit":"ignore",a=(0,Oe.spawn)(r,n,{stdio:s});await new Promise((l,m)=>{a.on("close",g=>{process.chdir(i),g!==0?m(new Error(Q(r,n,g))):l()}),a.on("error",g=>{process.chdir(i),console.error(Z(t,g)),m(g)})})}catch(i){console.error(ee(t,i)),process.exit(1)}}async function ct(e,{template:t="init",install:r=!0}){if(!e)throw new Error(z());if(e.startsWith("http"))throw new Error(L());let n=C.default.isAbsolute(e)?e:C.default.join(process.cwd(),e),i=C.default.basename(n);try{await ve(n,i),t==="init"?await be(n,i,t):await Fe(n,i,t),await Te(n,i,t),r&&await Me(n,i),await _e(n,i),await Re(n,i),await We(n,i),await Ae(n),Ee(t)&&await Ne(n,i);let s=await V(n,i);console.log(s)}catch(s){throw console.error(s),s}}0&&(module.exports={extensionCreate});
|
package/package.json
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
"node": ">=18"
|
|
10
10
|
},
|
|
11
11
|
"name": "extension-create",
|
|
12
|
-
"version": "2.0.0-alpha.
|
|
12
|
+
"version": "2.0.0-alpha.10",
|
|
13
13
|
"description": "The Extension.js create step",
|
|
14
14
|
"main": "./dist/module.js",
|
|
15
15
|
"types": "./dist/module.d.ts",
|
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
"@colors/colors": "^1.6.0",
|
|
33
33
|
"cross-spawn": "^7.0.3",
|
|
34
34
|
"detect-package-manager": "^3.0.2",
|
|
35
|
-
"go-git-it": "
|
|
35
|
+
"go-git-it": "2.0.4"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
38
|
"@types/cross-spawn": "^6.0.6",
|