empathicqubit/vscode-vsce
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

treat readme.md as asset

Browse source
This commit is contained in:
Joao Moreno 2015-10-13 17:43:06 +02:00
parent 91c2dbe8f2
commit acfb3657a1
3 changed files with 50 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
resources/extension.vsixmanifest
View file

@ -12,6 +12,7 @@
</Installation>
<Dependencies/>
<Assets>
<Asset Type="Microsoft.VisualStudio.Code.Manifest" Path="extension/package.json"/>
<Asset Type="Microsoft.VisualStudio.Code.Manifest" Path="extension/package.json" />
<% _.forEach(assets, function (asset) { %><Asset Type="${ asset.type }" Path="${ asset.path }" /><% }); %>
</Assets>
</PackageManifest>

35
src/package.ts
View file

@ -27,6 +27,11 @@ export interface IPackageResult {
packagePath: string;
}
export interface IAsset {
type: string;
path: string;
}
function validateManifest(manifest: Manifest): Promise<Manifest> {
if (!manifest.publisher) {
return Promise.reject('Manifest missing field: publisher');
@ -82,7 +87,15 @@ function prepublish(cwd: string, manifest: Manifest): Promise<Manifest> {
.catch(err => Promise.reject(err.message));
}
export function toVsixManifest(manifest: Manifest): Promise<string> {
export function toVsixManifest(manifest: Manifest, files: IFile[]): Promise<string> {
const assets = files.map<IAsset>(f => {
if (/^extension\/README.md$/i.test(f.path)) {
return { type: 'Microsoft.VisualStudio.Services.Content.Details', path: f.path };
}
return null;
}).filter(f => !!f);
return readFile(vsixManifestTemplatePath, 'utf8')
.then(vsixManifestTemplateStr => _.template(vsixManifestTemplateStr))
.then(vsixManifestTemplate => vsixManifestTemplate({
@ -92,7 +105,7 @@ export function toVsixManifest(manifest: Manifest): Promise<string> {
publisher: manifest.publisher,
description: manifest.description || '',
tags: (manifest.keywords || []).concat('vscode').join(';'),
assets: []
assets
}));
}
@ -122,13 +135,17 @@ function collectFiles(cwd: string, manifest: Manifest): Promise<string[]> {
}
export function collect(cwd: string, manifest: Manifest): Promise<IFile[]> {
return Promise.all<any>([toVsixManifest(manifest), collectFiles(cwd, manifest)])
.then<{ vsixManifest: string; files: string[]; }>(promises => <any> _.indexBy(promises, (o,i) => i ? 'files' : 'vsixManifest'))
.then(({ vsixManifest, files }) => [
{ path: 'extension.vsixmanifest', contents: new Buffer(vsixManifest, 'utf8') },
{ path: '[Content_Types].xml', localPath: path.join(resourcesPath, '[Content_Types].xml') },
...files.map(f => ({ path: `extension/${ f }`, localPath: path.join(cwd, f) }))
]);
return collectFiles(cwd, manifest).then(fileNames => {
const files = fileNames.map(f => ({ path: `extension/${ f }`, localPath: path.join(cwd, f) }));
return toVsixManifest(manifest, files).then(vsixManifest => {
return [
{ path: 'extension.vsixmanifest', contents: new Buffer(vsixManifest, 'utf8') },
{ path: '[Content_Types].xml', localPath: path.join(resourcesPath, '[Content_Types].xml') },
...files
];
});
});
}
function writeVsix(files: IFile[], packagePath: string): Promise<string> {

23
test/package.test.js
View file

@ -69,7 +69,7 @@ describe('toVsixManifest', () => {
description: 'test extension'
};
return toVsixManifest(manifest)
return toVsixManifest(manifest, [])
.then(xml => parseXml(xml))
.then(result => {
assert.ok(result);
@ -97,4 +97,25 @@ describe('toVsixManifest', () => {
assert.equal(result.PackageManifest.Assets[0].Asset[0].$.Path, 'extension/package.json');
});
});
it('should treat README.md as asset', () => {
const manifest = {
name: 'test',
publisher: 'mocha',
version: '0.0.1',
description: 'test extension'
};
const files = [
{ path: 'extension/readme.md' }
];
return toVsixManifest(manifest, files)
.then(xml => parseXml(xml))
.then(result => {
assert.equal(result.PackageManifest.Assets[0].Asset.length, 2);
assert.equal(result.PackageManifest.Assets[0].Asset[1].$.Type, 'Microsoft.VisualStudio.Services.Content.Details');
assert.equal(result.PackageManifest.Assets[0].Asset[1].$.Path, 'extension/readme.md');
});
});
});