448803582

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/PicGo/vs-picgo/commit/<a class=hub.com/PicGo/vs-picgo/commit/<a class="double-link" href="https://git"><a class=hub.com/PicGo/vs-picgo/commit/<a class="double-link" href="https://git"><a class=hub.com/PicGo/vs-picgo/commit/c2a68adacf1d7219e6df6c9fb9e8800ea9735711">c2a68adac<a href="https://github.com/PicGo/vs-picgo/commit/c2a68adacf1d7219e6df6c9fb9e8800ea9735711">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/PicGo/vs-picgo/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/PicGo/vs-picgo/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/PicGo/vs-picgo/commit/c2a68adacf1d7219e6df6c9fb9e8800ea9735711&quot;&gt;c2a68adac&lt;/a&gt;&lt;a href=&quot;https://github.com/PicGo/vs-picgo/commit/c2a68adacf1d7219e6df6c9fb9e8800ea9735711&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/PicGo/vs-picgo/commit/c2a68adacf1d7219e6df6c9fb9e8800e&lt;/a&gt;a9735711">&quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/PicGo/vs-picgo/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/PicGo/vs-picgo/commit/<a class="double-link" href="https://github.com/PicGo/vs-picgo/commit/164f3582b69939444266e2860cc866cfe2a6e266">164f3582b</a><a href="https://github.com/PicGo/vs-picgo/commit/c2a68adacf1d7219e6df6c9fb9e8800ea9735711">&amp;quot;&amp;gt;164f3582b&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;164f3582b&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/PicGo/vs-picgo/commit/c2a68adacf1d7219e6df6c9fb9e8800ea9735&lt;/a&gt;711&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/PicGo/vs-picgo/commit/<a class="double-link" href="https://github.com/PicGo/vs-picgo/commit/334769060">334769060">334769060</a>

Pull Request Pull Request #78: Fix powershell clipboard

Run Details

23 of 56 branches covered (41.07%)

Branch coverage included in aggregate %.

18 of 18 new or added lines in 3 files covered. (100.0%)

117 of 164 relevant lines covered (71.34%)

2.55 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

75.74

/src/vs-picgo/index.ts

import { EventEmitter } from 'events';
import * as fs from 'fs';
import * as path from 'path';
import * as os from 'os';
import * as vscode from 'vscode';

import PicGo from 'picgo/dist/src/core/PicGo';
import { IImgInfo, IPlugin, IConfig as IPicGoConfig } from 'picgo/dist/src/utils/interfaces';

import { promisify } from 'util';

import { formatParam, formatString, showInfo, showError, getUploadedName } from '../utils';

const _ = require('lodash');
const _db = require('lodash-id');
import nls = require('../../package.nls.json');
_.mixin(_db);

const writeFileP = promisify(fs.writeFile);
const readFileP = promisify(fs.readFile);

export interface INotice {
  body: string;
  text: string;
  title: string;
}

export interface IUploadName {
  date: string;
  dateTime: string;
  fileName: string;
  extName: string;
  mdFileName: string;
  [key: string]: string;
}

export interface IOutputUrl {
  uploadedName: string;
  url: string;
  [key: string]: string;
}

export enum EVSPicgoHooks {
  updated = 'updated',
}

export default class VSPicgo extends EventEmitter {
  private static picgo: PicGo = new PicGo();

  constructor() {
    super();
    this.configPicgo();
    // Before upload, we change names of the images.
    this.registerRenamePlugin();
    // After upload, we use the custom output format.
    this.addGenerateOutputListener();
  }

  configPicgo() {
    const picgoConfigPath = vscode.workspace.getConfiguration('picgo').get<string>('configPath');
    let config: Partial<IPicGoConfig>;
    if (picgoConfigPath) {
      config = JSON.parse(
        fs.readFileSync(picgoConfigPath, {
          encoding: 'utf-8',
        }),
      );
    } else {
      const picBed = (vscode.workspace.getConfiguration('picgo.picBed') as any) as IPicGoConfig['picBed'];
      config = { picBed };
    }

    // `PICGO_ENV` is used only by Electron version, should be disabled here,
    // see https://github.com/PicGo/vs-picgo/issues/75 for more detail
    (config as any)['PICGO_ENV'] = 'CLI';
    VSPicgo.picgo.setConfig(config);
  }

  addGenerateOutputListener() {
    VSPicgo.picgo.on('finished', async (ctx: PicGo) => {
      let urlText = '';
      const outputFormatTemplate =
        vscode.workspace.getConfiguration('picgo').get<string>('customOutputFormat') || '![${uploadedName}](${url})';
      try {
        urlText = ctx.output.reduce((acc: string, imgInfo: IImgInfo): string => {
          return `${acc}${formatString(outputFormatTemplate, {
            uploadedName: getUploadedName(imgInfo),
            url: imgInfo.imgUrl,
          })}\n`;
        }, '');
        urlText = urlText.trim();
        await this.updateData(ctx.output);
      } catch (err) {
        if (err instanceof SyntaxError) {
          showError(
            `the data file ${this.dataPath} has syntax error, ` +
              `please fix the error by yourself or delete the data file and vs-picgo will recreate for you.`,
          );
        } else {
          showError(`failed to read from data file ${this.dataPath}: ${err || ''}`);
        }
        return;
      }
      this.editor.edit(textEditor => {
        textEditor.replace(this.editor.selection, urlText);
        showInfo(`image uploaded successfully.`);
        this.emit(EVSPicgoHooks.updated, urlText);
      });
    });
  }

  registerRenamePlugin() {
    let beforeUploadPlugin: IPlugin = {
      handle: (ctx: PicGo) => {
        const uploadNameTemplate =
          vscode.workspace.getConfiguration('picgo').get<string>('customUploadName') || '${fileName}';
        if (ctx.output.length === 1) {
          ctx.output[0].fileName = this.changeFilename(ctx.output[0].fileName || '', uploadNameTemplate, undefined);
        } else {
          ctx.output.forEach((imgInfo: IImgInfo, index: number) => {
            imgInfo.fileName = this.changeFilename(imgInfo.fileName || '', uploadNameTemplate, index);
          });
        }
      },
    };
    VSPicgo.picgo.helper.beforeUploadPlugins.register('vsPicgoRenamePlugin', beforeUploadPlugin);
  }

  /**
   * Returns the modified file name as per `customUploadName` setting
   * @param original The filename of the original image file.
   * @param template The template string.
   */
  changeFilename(original: string, template: string, index: number | undefined) {
    if (this.userDefineName) {
      original = this.userDefineName + (index || '') + path.extname(original);
    }
    const mdFilePath = this.editor.document.fileName;
    const mdFileName = path.basename(mdFilePath, path.extname(mdFilePath));
    let uploadNameData = formatParam(original, mdFileName);
    return formatString(template, uploadNameData);
  }

  get editor(): vscode.TextEditor {
    const editor = vscode.window.activeTextEditor;
    if (!editor) {
      showError('no active markdown editor!');
    }
    return editor as vscode.TextEditor;
  }
  get dataPath(): string {
    const picgoConfig = vscode.workspace.getConfiguration('picgo');
    return picgoConfig.dataPath || path.resolve(os.homedir(), 'vs-picgo-data.json');
  }
  get userDefineName(): string {
    let selectedString = this.editor.document.getText(this.editor.selection);
    const nameReg = /[:\/\?\$]+/g; // limitations of name
    selectedString = selectedString.replace(nameReg, () => '');
    return selectedString;
  }

  async initDataFile(dataPath: string) {
    if (!fs.existsSync(dataPath)) {
      await writeFileP(dataPath, JSON.stringify({ uploaded: [] }, null, 2), 'utf8');
    }
  }

  async upload(input?: string[]) {
    // This is necessary, because user may have changed settings
    this.configPicgo();

    // uploading progress
    vscode.window.withProgress(
      {
        location: vscode.ProgressLocation.Notification,
        title: `${nls['ext.displayName']}: image uploading...`,
        cancellable: false,
      },
      progress => {
        return new Promise<void>((resolve, reject) => {
          VSPicgo.picgo.on('uploadProgress', (p: number) => {
            progress.report({ increment: p });
            if (p === 100) {
              resolve();
            }
          });
          VSPicgo.picgo.on('failed', (error: Error) => {
            showError(error.message || 'Unknown error');
            reject();
          });
          VSPicgo.picgo.on('notification', (notice: INotice) => {
            showError(`${notice.title}! ${notice.body || ''}${notice.text || ''}`);
            reject();
          });
        });
      },
    );

    // Error has been handled in on 'failed'
    return VSPicgo.picgo.upload(input).catch(() => {});
  }

  async updateData(picInfos: Array<IImgInfo>) {
    const dataPath = this.dataPath;
    if (!fs.existsSync(dataPath)) {
      await this.initDataFile(dataPath);
      showInfo('data file created at ${dataPath}.');
    }
    const dataRaw = await readFileP(dataPath, 'utf8');
    const data = JSON.parse(dataRaw);
    if (!data.uploaded) {
      data.uploaded = [];
    }
    picInfos.forEach(picInfo => {
      _.insert(data['uploaded'], picInfo);
    });
    await writeFileP(dataPath, JSON.stringify(data, null, 2), 'utf8');
  }
}

1	import { EventEmitter } from 'events';	1✔
2	import * as fs from 'fs';	1✔
3	import * as path from 'path';	1✔
4	import * as os from 'os';	1✔
5	import * as vscode from 'vscode';	1✔
6
7	import PicGo from 'picgo/dist/src/core/PicGo';	1✔
8	import { IImgInfo, IPlugin, IConfig as IPicGoConfig } from 'picgo/dist/src/utils/interfaces';
9
10	import { promisify } from 'util';	1✔
11
12	import { formatParam, formatString, showInfo, showError, getUploadedName } from '../utils';	1✔
13
14	const _ = require('lodash');	1✔
15	const _db = require('lodash-id');	1✔
16	import nls = require('../../package.nls.json');	1✔
17	_.mixin(_db);	1✔
18
19	const writeFileP = promisify(fs.writeFile);	1✔
20	const readFileP = promisify(fs.readFile);	1✔
21
22	export interface INotice {
23	body: string;
24	text: string;
25	title: string;
26	}
27
28	export interface IUploadName {
29	date: string;
30	dateTime: string;
31	fileName: string;
32	extName: string;
33	mdFileName: string;
34	[key: string]: string;
35	}
36
37	export interface IOutputUrl {
38	uploadedName: string;
39	url: string;
40	[key: string]: string;
41	}
42
43	export enum EVSPicgoHooks {	2✔
44	updated = 'updated',	1✔
45	}
46
47	export default class VSPicgo extends EventEmitter {	1✔
48	private static picgo: PicGo = new PicGo();	1✔
49
50	constructor() {
51	super();	1✔
52	this.configPicgo();	1✔
53	// Before upload, we change names of the images.
54	this.registerRenamePlugin();	1✔
55	// After upload, we use the custom output format.
56	this.addGenerateOutputListener();	1✔
57	}
58
59	configPicgo() {
60	const picgoConfigPath = vscode.workspace.getConfiguration('picgo').get<string>('configPath');	4✔
61	let config: Partial<IPicGoConfig>;	4✔
62	if (picgoConfigPath) {	4!
63	config = JSON.parse(	×
64	fs.readFileSync(picgoConfigPath, {
65	encoding: 'utf-8',
66	}),
67	);
68	} else {
69	const picBed = (vscode.workspace.getConfiguration('picgo.picBed') as any) as IPicGoConfig['picBed'];	4✔
70	config = { picBed };	4✔
71	}
72
73	// `PICGO_ENV` is used only by Electron version, should be disabled here,
74	// see https://github.com/PicGo/vs-picgo/issues/75 for more detail
75	(config as any)['PICGO_ENV'] = 'CLI';	4✔
76	VSPicgo.picgo.setConfig(config);	4✔
77	}
78
79	addGenerateOutputListener() {
80	VSPicgo.picgo.on('finished', async (ctx: PicGo) => {	3✔
81	let urlText = '';	3✔
82	const outputFormatTemplate =	3✔
83	vscode.workspace.getConfiguration('picgo').get<string>('customOutputFormat') \|\| '![${uploadedName}](${url})';	3!
84	try {	3✔
85	urlText = ctx.output.reduce((acc: string, imgInfo: IImgInfo): string => {	3✔
86	return `${acc}${formatString(outputFormatTemplate, {	3✔
87	uploadedName: getUploadedName(imgInfo),
88	url: imgInfo.imgUrl,
89	})}\n`;
90	}, '');
91	urlText = urlText.trim();	3✔
92	await this.updateData(ctx.output);	3✔
93	} catch (err) {
94	if (err instanceof SyntaxError) {	×
95	showError(	×
96	`the data file ${this.dataPath} has syntax error, ` +
97	`please fix the error by yourself or delete the data file and vs-picgo will recreate for you.`,
98	);
99	} else {
100	showError(`failed to read from data file ${this.dataPath}: ${err \|\| ''}`);	×
101	}
102	return;	×
103	}
104	this.editor.edit(textEditor => {	3✔
105	textEditor.replace(this.editor.selection, urlText);	3✔
106	showInfo(`image uploaded successfully.`);	3✔
107	this.emit(EVSPicgoHooks.updated, urlText);	3✔
108	});
109	});
110	}
111
112	registerRenamePlugin() {
113	let beforeUploadPlugin: IPlugin = {	1✔
114	handle: (ctx: PicGo) => {
115	const uploadNameTemplate =	3✔
116	vscode.workspace.getConfiguration('picgo').get<string>('customUploadName') \|\| '${fileName}';	3!
117	if (ctx.output.length === 1) {	3!
118	ctx.output[0].fileName = this.changeFilename(ctx.output[0].fileName \|\| '', uploadNameTemplate, undefined);	3!
119	} else {
120	ctx.output.forEach((imgInfo: IImgInfo, index: number) => {	×
121	imgInfo.fileName = this.changeFilename(imgInfo.fileName \|\| '', uploadNameTemplate, index);	×
122	});
123	}
124	},
125	};
126	VSPicgo.picgo.helper.beforeUploadPlugins.register('vsPicgoRenamePlugin', beforeUploadPlugin);	1✔
127	}
128
129	/**
130	* Returns the modified file name as per `customUploadName` setting
131	* @param original The filename of the original image file.
132	* @param template The template string.
133	*/
134	changeFilename(original: string, template: string, index: number \| undefined) {
135	if (this.userDefineName) {	3✔
136	original = this.userDefineName + (index \|\| '') + path.extname(original);	1✔
137	}
138	const mdFilePath = this.editor.document.fileName;	3✔
139	const mdFileName = path.basename(mdFilePath, path.extname(mdFilePath));	3✔
140	let uploadNameData = formatParam(original, mdFileName);	3✔
141	return formatString(template, uploadNameData);	3✔
142	}
143
144	get editor(): vscode.TextEditor {
145	const editor = vscode.window.activeTextEditor;	17✔
146	if (!editor) {	17!
147	showError('no active markdown editor!');	×
148	}
149	return editor as vscode.TextEditor;	17✔
150	}
151	get dataPath(): string {
152	const picgoConfig = vscode.workspace.getConfiguration('picgo');	3✔
153	return picgoConfig.dataPath \|\| path.resolve(os.homedir(), 'vs-picgo-data.json');	3✔
154	}
155	get userDefineName(): string {
156	let selectedString = this.editor.document.getText(this.editor.selection);	4✔
157	const nameReg = /[:\/\?\$]+/g; // limitations of name	4✔
158	selectedString = selectedString.replace(nameReg, () => '');	4✔
159	return selectedString;	4✔
160	}
161
162	async initDataFile(dataPath: string) {
163	if (!fs.existsSync(dataPath)) {	1!
164	await writeFileP(dataPath, JSON.stringify({ uploaded: [] }, null, 2), 'utf8');	1✔
165	}
166	}
167
168	async upload(input?: string[]) {
169	// This is necessary, because user may have changed settings
170	this.configPicgo();	3✔
171
172	// uploading progress
173	vscode.window.withProgress(	3✔
174	{
175	location: vscode.ProgressLocation.Notification,
176	title: `${nls['ext.displayName']}: image uploading...`,
177	cancellable: false,
178	},
179	progress => {
180	return new Promise<void>((resolve, reject) => {	3✔
181	VSPicgo.picgo.on('uploadProgress', (p: number) => {	3✔
182	progress.report({ increment: p });	24✔
183	if (p === 100) {	24✔
184	resolve();	6✔
185	}
186	});
187	VSPicgo.picgo.on('failed', (error: Error) => {	3✔
188	showError(error.message \|\| 'Unknown error');	×
189	reject();	×
190	});
191	VSPicgo.picgo.on('notification', (notice: INotice) => {	3✔
192	showError(`${notice.title}! ${notice.body \|\| ''}${notice.text \|\| ''}`);	×
193	reject();	×
194	});
195	});
196	},
197	);
198
199	// Error has been handled in on 'failed'
200	return VSPicgo.picgo.upload(input).catch(() => {});	3✔
201	}
202
203	async updateData(picInfos: Array<IImgInfo>) {
204	const dataPath = this.dataPath;	3✔
205	if (!fs.existsSync(dataPath)) {	3✔
206	await this.initDataFile(dataPath);	1✔
207	showInfo('data file created at ${dataPath}.');	1✔
208	}
209	const dataRaw = await readFileP(dataPath, 'utf8');	3✔
210	const data = JSON.parse(dataRaw);	3✔
211	if (!data.uploaded) {	3!
212	data.uploaded = [];	×
213	}
214	picInfos.forEach(picInfo => {	3✔
215	_.insert(data['uploaded'], picInfo);	3✔
216	});
217	await writeFileP(dataPath, JSON.stringify(data, null, 2), 'utf8');	3✔
218	}
219	}

PicGo / vs-picgo / 448803582

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous