Merge pull request #508 from FabianHenneke/master

Ensure package.json is writable in *.vsix

Author: joaomoreno

src/package.ts

@@ -37,11 +37,13 @@ const MinimatchOptions: minimatch.IOptions = { dot: true };
 
 export interface IInMemoryFile {
 	path: string;
+	mode?: number;
 	readonly contents: Buffer | string;
 }
 
 export interface ILocalFile {
 	path: string;
+	mode?: number;
 	readonly localPath: string;
 }
 
@@ -208,7 +210,7 @@ function isHostTrusted(url: url.UrlWithStringQuery): boolean {
 	return TrustedSVGSources.indexOf(url.host.toLowerCase()) > -1 || isGitHubBadge(url.href);
 }
 
-class ManifestProcessor extends BaseProcessor {
+export class ManifestProcessor extends BaseProcessor {
 	constructor(manifest: Manifest) {
 		super(manifest);
 
@@ -274,6 +276,18 @@ class ManifestProcessor extends BaseProcessor {
 		}
 	}
 
+	async onFile(file: IFile): Promise<IFile> {
+		const path = util.normalize(file.path);
+
+		if (!/^extension\/package.json$/i.test(path)) {
+			return Promise.resolve(file);
+		}
+
+		// Ensure that package.json is writable as VS Code needs to
+		// store metadata in the extracted file.
+		return { ...file, mode: 0o100644 };
+	}
+
 	async onEnd(): Promise<void> {
 		if (typeof this.manifest.extensionKind === 'string') {
 			util.log.warn(
@@ -1104,8 +1118,10 @@ function writeVsix(files: IFile[], packagePath: string): Promise<void> {
 					const zip = new yazl.ZipFile();
 					files.forEach(f =>
 						isInMemoryFile(f)
-							? zip.addBuffer(typeof f.contents === 'string' ? Buffer.from(f.contents, 'utf8') : f.contents, f.path)
-							: zip.addFile(f.localPath, f.path)
+							? zip.addBuffer(typeof f.contents === 'string' ? Buffer.from(f.contents, 'utf8') : f.contents, f.path, {
+									mode: f.mode,
+							  })
+							: zip.addFile(f.localPath, f.path, { mode: f.mode })
 					);
 					zip.end();
 

src/test/package.test.ts

@@ -13,6 +13,7 @@ import {
 	WebExtensionProcessor,
 	IAsset,
 	IPackageOptions,
+	ManifestProcessor,
 } from '../package';
 import { Manifest } from '../manifest';
 import * as path from 'path';
@@ -1684,6 +1685,21 @@ describe('toContentTypes', () => {
 	});
 });
 
+describe('ManifestProcessor', () => {
+	it('should ensure that package.json is writable', async () => {
+		const root = fixture('uuid');
+		const manifest = JSON.parse(await readFile(path.join(root, 'package.json'), 'utf8'));
+		const processor = new ManifestProcessor(manifest);
+		const packageJson = {
+			path: 'extension/package.json',
+			localPath: path.join(root, 'package.json'),
+		};
+
+		const outPackageJson = await processor.onFile(packageJson);
+		assert.ok(outPackageJson.mode & 0o200);
+	});
+});
+
 describe('MarkdownProcessor', () => {
 	it('should throw when no baseContentUrl is provided', async () => {
 		const manifest = {