plugins/packages/plugin-tools/src/lib.test.ts at 15b265cd9fc8884943d8d1c3dec82010970b4a4e · framer/plugins · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
import fs from "node:fs"
import os from "node:os"
import path from "node:path"
import AdmZip from "adm-zip"
import { afterEach, beforeEach, describe, expect, it } from "vitest"
import { detectPackageManager, normalizeZipEntryPaths, zipPluginDistribution } from "./lib"

describe("detectPackageManager", () => {
    let tmpDir: string

    beforeEach(() => {
        tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "pm-detect-"))
    })

    afterEach(() => {
        fs.rmSync(tmpDir, { recursive: true })
    })

    it("detects yarn from yarn.lock", () => {
        fs.writeFileSync(path.join(tmpDir, "yarn.lock"), "")
        expect(detectPackageManager(tmpDir)).toBe("yarn")
    })

    it("detects pnpm from pnpm-lock.yaml", () => {
        fs.writeFileSync(path.join(tmpDir, "pnpm-lock.yaml"), "")
        expect(detectPackageManager(tmpDir)).toBe("pnpm")
    })

    it("detects bun from bun.lockb", () => {
        fs.writeFileSync(path.join(tmpDir, "bun.lockb"), "")
        expect(detectPackageManager(tmpDir)).toBe("bun")
    })

    it("detects bun from bun.lock", () => {
        fs.writeFileSync(path.join(tmpDir, "bun.lock"), "")
        expect(detectPackageManager(tmpDir)).toBe("bun")
    })

    it("detects npm from package-lock.json", () => {
        fs.writeFileSync(path.join(tmpDir, "package-lock.json"), "{}")
        expect(detectPackageManager(tmpDir)).toBe("npm")
    })

    it("defaults to npm when no lockfile found", () => {
        expect(detectPackageManager(tmpDir)).toBe("npm")
    })

    it("finds lockfile in parent directory", () => {
        const childDir = path.join(tmpDir, "packages", "child")
        fs.mkdirSync(childDir, { recursive: true })
        fs.writeFileSync(path.join(tmpDir, "yarn.lock"), "")
        expect(detectPackageManager(childDir)).toBe("yarn")
    })

    it("finds lockfile up to 2 levels up", () => {
        const deepDir = path.join(tmpDir, "a", "b")
        fs.mkdirSync(deepDir, { recursive: true })
        fs.writeFileSync(path.join(tmpDir, "pnpm-lock.yaml"), "")
        expect(detectPackageManager(deepDir)).toBe("pnpm")
    })

    it("does not find lockfile more than 3 levels up", () => {
        const deepDir = path.join(tmpDir, "a", "b", "c")
        fs.mkdirSync(deepDir, { recursive: true })
        fs.writeFileSync(path.join(tmpDir, "yarn.lock"), "")
        expect(detectPackageManager(deepDir)).toBe("npm")
    })

    it("prefers closer lockfile over parent", () => {
        const childDir = path.join(tmpDir, "child")
        fs.mkdirSync(childDir)
        fs.writeFileSync(path.join(tmpDir, "yarn.lock"), "")
        fs.writeFileSync(path.join(childDir, "pnpm-lock.yaml"), "")
        expect(detectPackageManager(childDir)).toBe("pnpm")
    })
})

describe("zipPluginDistribution", () => {
    let tmpDir: string

    beforeEach(() => {
        tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "pack-plugin-"))
    })

    afterEach(() => {
        fs.rmSync(tmpDir, { recursive: true })
    })

    it("creates a ZIP file with correct contents", () => {
        const distDir = path.join(tmpDir, "dist")
        fs.mkdirSync(distDir)
        fs.writeFileSync(path.join(distDir, "index.js"), "console.log('hello')")
        fs.writeFileSync(path.join(distDir, "index.html"), "<html></html>")

        const zipFilePath = zipPluginDistribution({
            cwd: tmpDir,
            distPath: "dist",
            zipFileName: "plugin.zip",
        })

        expect(fs.existsSync(zipFilePath)).toBe(true)

        const zip = new AdmZip(zipFilePath)
        const entries = zip.getEntries().map(e => e.entryName)
        expect(entries).toContain("index.js")
        expect(entries).toContain("index.html")
        expect(entries).toContain("framer-plugin-packed.txt")

        const jsContent = zip.readAsText("index.js")
        expect(jsContent).toBe("console.log('hello')")

        const packedContent = zip.readAsText("framer-plugin-packed.txt")
        expect(packedContent).toBe("true")
    })

    it("injects framer-plugin-packed.txt with contents 'true'", () => {
        const distDir = path.join(tmpDir, "dist")
        fs.mkdirSync(distDir)
        fs.writeFileSync(path.join(distDir, "index.js"), "")

        zipPluginDistribution({
            cwd: tmpDir,
            distPath: "dist",
            zipFileName: "plugin.zip",
        })

        const zip = new AdmZip(path.join(tmpDir, "plugin.zip"))
        expect(zip.readAsText("framer-plugin-packed.txt")).toBe("true")
    })

    it("overwrites dist framer-plugin-packed.txt with injected marker", () => {
        const distDir = path.join(tmpDir, "dist")
        fs.mkdirSync(distDir)
        fs.writeFileSync(path.join(distDir, "framer-plugin-packed.txt"), "false or custom")
        fs.writeFileSync(path.join(distDir, "index.js"), "")

        zipPluginDistribution({
            cwd: tmpDir,
            distPath: "dist",
            zipFileName: "plugin.zip",
        })

        const zip = new AdmZip(path.join(tmpDir, "plugin.zip"))
        const entriesWithSameName = zip.getEntries().filter(e => e.entryName === "framer-plugin-packed.txt")
        expect(entriesWithSameName).toHaveLength(1)
        expect(zip.readAsText("framer-plugin-packed.txt")).toBe("true")
    })

    it("throws error when dist directory does not exist", () => {
        expect(() =>
            zipPluginDistribution({
                cwd: tmpDir,
                distPath: "dist",
                zipFileName: "plugin.zip",
            })
        ).toThrow(/does not exist/)
    })

    it("throws error when distPath is a file, not a directory", () => {
        const filePath = path.join(tmpDir, "dist")
        fs.writeFileSync(filePath, "i am a file")

        expect(() =>
            zipPluginDistribution({
                cwd: tmpDir,
                distPath: "dist",
                zipFileName: "plugin.zip",
            })
        ).toThrow(/is not directory/)
    })

    it("respects custom output filename", () => {
        const distDir = path.join(tmpDir, "dist")
        fs.mkdirSync(distDir)
        fs.writeFileSync(path.join(distDir, "index.js"), "")

        const zipFilePath = zipPluginDistribution({
            cwd: tmpDir,
            distPath: "dist",
            zipFileName: "my-custom-plugin.zip",
        })

        expect(zipFilePath).toBe(path.join(tmpDir, "my-custom-plugin.zip"))
        expect(fs.existsSync(zipFilePath)).toBe(true)
    })

    it("handles nested directory structures", () => {
        const distDir = path.join(tmpDir, "dist")
        const nestedDir = path.join(distDir, "assets", "images")
        fs.mkdirSync(nestedDir, { recursive: true })
        fs.writeFileSync(path.join(distDir, "index.js"), "")
        fs.writeFileSync(path.join(nestedDir, "logo.png"), "fake-png-data")

        const zipFilePath = zipPluginDistribution({
            cwd: tmpDir,
            distPath: "dist",
            zipFileName: "plugin.zip",
        })

        const zip = new AdmZip(zipFilePath)
        const entries = zip.getEntries().map(e => e.entryName)
        expect(entries).toContain("index.js")
        expect(entries).toContain("assets/images/logo.png")
    })

    it("normalizes backslash entry names to use forward slashes", () => {
        const zip = new AdmZip()
        zip.addFile("nested\\dir\\file.txt", Buffer.from("content", "utf-8"))

        normalizeZipEntryPaths(zip)

        const entries = zip.getEntries().map(e => e.entryName)
        expect(entries).toContain("nested/dir/file.txt")
        expect(entries).not.toContain("nested\\dir\\file.txt")
    })

    it("returns correct zipPath", () => {
        const distDir = path.join(tmpDir, "dist")
        fs.mkdirSync(distDir)
        fs.writeFileSync(path.join(distDir, "index.js"), "")

        const zipFilePath = zipPluginDistribution({
            cwd: tmpDir,
            distPath: "dist",
            zipFileName: "output.zip",
        })

        expect(zipFilePath).toBe(path.join(tmpDir, "output.zip"))
    })

    it("supports custom distPath", () => {
        const buildDir = path.join(tmpDir, "build", "output")
        fs.mkdirSync(buildDir, { recursive: true })
        fs.writeFileSync(path.join(buildDir, "bundle.js"), "bundled code")

        const zipFilePath = zipPluginDistribution({
            cwd: tmpDir,
            distPath: "build/output",
            zipFileName: "plugin.zip",
        })

        const zip = new AdmZip(zipFilePath)
        const entries = zip.getEntries().map(e => e.entryName)
        expect(entries).toContain("bundle.js")
    })

    it("uses absolute distPath directly without joining with cwd", () => {
        const absoluteDistDir = path.join(tmpDir, "absolute-dist")
        fs.mkdirSync(absoluteDistDir)
        fs.writeFileSync(path.join(absoluteDistDir, "index.js"), "absolute content")

        const absoluteZipPath = path.join(tmpDir, "plugin.zip")

        const zipFilePath = zipPluginDistribution({
            cwd: "/some/other/path",
            distPath: absoluteDistDir,
            zipFileName: absoluteZipPath,
        })

        const zip = new AdmZip(zipFilePath)
        const content = zip.readAsText("index.js")
        expect(content).toBe("absolute content")
    })

    it("uses absolute zipFileName directly without joining with cwd", () => {
        const distDir = path.join(tmpDir, "dist")
        fs.mkdirSync(distDir)
        fs.writeFileSync(path.join(distDir, "index.js"), "")

        const absoluteZipPath = path.join(tmpDir, "output", "my-plugin.zip")
        fs.mkdirSync(path.dirname(absoluteZipPath), { recursive: true })

        const zipFilePath = zipPluginDistribution({
            cwd: "/some/other/path",
            distPath: distDir,
            zipFileName: absoluteZipPath,
        })

        expect(zipFilePath).toBe(absoluteZipPath)
        expect(fs.existsSync(absoluteZipPath)).toBe(true)
    })
})