yaml-language-server
Version:
314 lines (311 loc) • 11.9 kB
JavaScript
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
/*---------------------------------------------------------------------------------------------
* Copyright (c) Red Hat. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
const assert_1 = __importDefault(require("assert"));
const sinon = __importStar(require("sinon"));
const yamlSettings_1 = require("../src/yamlSettings");
const serviceSetup_1 = require("./utils/serviceSetup");
const testHelper_1 = require("./utils/testHelper");
describe('Formatter Tests', () => {
const sandbox = sinon.createSandbox();
let languageHandler;
let yamlSettings;
afterEach(() => {
sandbox.restore();
});
before(() => {
const languageSettingsSetup = new serviceSetup_1.ServiceSetup().withFormat();
const { languageHandler: langHandler, yamlSettings: settings } = (0, testHelper_1.setupLanguageService)(languageSettingsSetup.languageSettings);
languageHandler = langHandler;
yamlSettings = settings;
});
// Tests for formatter
describe('Formatter', function () {
describe('Test that formatter works with custom tags', function () {
function parseSetup(content, options = {}) {
const testTextDocument = (0, testHelper_1.setupTextDocument)(content);
yamlSettings.documents = new yamlSettings_1.TextDocumentTestManager();
yamlSettings.documents.set(testTextDocument);
yamlSettings.yamlFormatterSettings = options;
return languageHandler.formatterHandler({
options: options,
textDocument: testTextDocument,
});
}
it('Formatting works without custom tags', async () => {
const content = 'cwd: test';
const edits = await parseSetup(content);
console.dir({ edits });
assert_1.default.notEqual(edits.length, 0);
assert_1.default.equal(edits[0].newText, 'cwd: test\n');
});
it('Formatting can be disabled via language-overridable yaml.format.enable setting', async () => {
const content = 'cwd: test\n test: 2';
const testTextDocument = (0, testHelper_1.setupTextDocument)(content);
yamlSettings.documents = new yamlSettings_1.TextDocumentTestManager();
yamlSettings.documents.set(testTextDocument);
const connection = languageHandler.connection;
sandbox.stub(connection.workspace, 'getConfiguration').resolves({ 'yaml.format.enable': false });
yamlSettings.hasConfigurationCapability = true;
const edits = await languageHandler.formatterHandler({
options: { tabSize: 2, insertSpaces: true },
textDocument: testTextDocument,
});
assert_1.default.equal(edits.length, 0);
});
it('Formatting works with custom tags', async () => {
const content = 'cwd: !Test test';
const edits = await parseSetup(content);
assert_1.default.notEqual(edits.length, 0);
assert_1.default.equal(edits[0].newText, 'cwd: !Test test\n');
});
it('Formatting wraps text', async () => {
const content = `comments: >
test test test test test test test test test test test test`;
const edits = await parseSetup(content, {
printWidth: 20,
proseWrap: 'always',
});
assert_1.default.equal(edits[0].newText, 'comments: >\n test test test\n test test test\n test test test\n test test test\n');
});
it('Formatting handles trailing commas (enabled)', async () => {
const content = `{
key: 'value',
food: 'raisins',
airport: 'YYZ',
lightened_bulb: 'illuminating',
}
`;
const edits = await parseSetup(content, { singleQuote: true });
assert_1.default.equal(edits.length, 0);
});
it('Formatting handles trailing commas (disabled)', async () => {
const content = `{
key: 'value',
food: 'raisins',
airport: 'YYZ',
lightened_bulb: 'illuminating',
}
`;
const edits = await parseSetup(content, {
singleQuote: true,
trailingComma: false,
});
assert_1.default.equal(edits[0].newText, `{
key: 'value',
food: 'raisins',
airport: 'YYZ',
lightened_bulb: 'illuminating'
}
`);
});
it('Formatting uses tabSize', async () => {
const content = `map:
k1: v1
k2: v2
list:
- item1
- item2
`;
const edits = await parseSetup(content, {
tabSize: 5,
});
const expected = `map:
k1: v1
k2: v2
list:
- item1
- item2
`;
assert_1.default.equal(edits[0].newText, expected);
});
it('Formatting uses tabWidth', async () => {
const content = `map:
k1: v1
k2: v2
list:
- item1
- item2
`;
const edits = await parseSetup(content, {
tabWidth: 5,
});
const expected = `map:
k1: v1
k2: v2
list:
- item1
- item2
`;
assert_1.default.equal(edits[0].newText, expected);
});
it('Formatting uses tabWidth over tabSize', async () => {
const content = `map:
k1: v1
k2: v2
list:
- item1
- item2
`;
const edits = await parseSetup(content, {
tabSize: 3,
tabWidth: 5,
});
const expected = `map:
k1: v1
k2: v2
list:
- item1
- item2
`;
assert_1.default.equal(edits[0].newText, expected);
});
it("Formatting doesn't replace escaped newlines with real ones", async () => {
const content = `- name: Example task
set_fact:
my_var: "{{ content | regex_replace('\\\\\\\\n', '\\n') }}"
`;
const edits = await parseSetup(content, {
tabSize: 1,
tabWidth: 2,
});
assert_1.default.equal(edits.length, 0, `Edits: ${JSON.stringify(edits)}`);
});
it("Formatting doesn't strip trailing zeros of floats", async () => {
const content = `value: 1.0e+4
`;
const edits = await parseSetup(content, {
tabSize: 1,
tabWidth: 2,
});
assert_1.default.equal(edits.length, 0, `Edits: ${JSON.stringify(edits)}`);
});
it("Formatting doesn't convert long integers to floats", async () => {
const content = `value: 12345678901234567890
`;
const edits = await parseSetup(content, {
tabSize: 1,
tabWidth: 2,
});
assert_1.default.equal(edits.length, 0, `Edits: ${JSON.stringify(edits)}`);
});
it("Formatting respects 'no prose wrap' setting", async () => {
const content = `value: aaaa aaaa aaaa aaaa aaaa aaaa aaaa aaaa aaaa aaaa aaaa aaaa aaaa aaaa aaaa aaaa aaaa aaaa aaaa aaaa aaaa aaaa aaaa
`;
const edits = await parseSetup(content, {
tabSize: 1,
tabWidth: 2,
proseWrap: 'never',
});
assert_1.default.equal(edits.length, 0, `Edits: ${JSON.stringify(edits)}`);
const edits2 = await parseSetup(content, {
tabSize: 1,
tabWidth: 2,
proseWrap: 'preserve',
});
assert_1.default.equal(edits2.length, 0, `Edits: ${JSON.stringify(edits)}`);
});
it('Formatting keeps comments on the same line', async () => {
const content = `0002-https-from-avdpool-to-server: # Allow HTTPS access from AVD Pool 2 to Qlik server
name: 0002-https-from-avdpool-to-server
source_addresses:
- 1.2.3.4/32
protocols:
- TCP
destination_ports:
- "443"
destination_addresses:
- 4.5.6.7/32
`;
const edits = await parseSetup(content, {
tabSize: 1,
tabWidth: 2,
});
assert_1.default.equal(edits.length, 0, `Edits: ${JSON.stringify(edits)}`);
});
it('Formatting converts quotations', async () => {
const content = `root:
- it: "should include default selector"
`;
const expected = `root:
- it: 'should include default selector'
`;
const edits = await parseSetup(content, {
tabSize: 1,
tabWidth: 2,
singleQuote: true,
});
assert_1.default.equal(edits[0].newText, expected);
});
it("Formatting empty doc doesn't do anything", async () => {
const content = `
`;
const expected = ``;
const edits = await parseSetup(content, {
tabSize: 1,
tabWidth: 2,
singleQuote: true,
});
assert_1.default.equal(edits[0].newText, expected);
});
it('Comments separated by blank lines do not inherit indentation of previous lines', async () => {
const content = `# Section 1
variables:
- "C"
- 1
- false
# four: true
# Section 2
more_variables:
- "A"
- 2
`;
const edits = await parseSetup(content, {
tabSize: 1,
tabWidth: 2,
});
assert_1.default.equal(edits.length, 0, `Edits: ${JSON.stringify(edits)}`);
});
});
});
});
//# sourceMappingURL=formatter.test.js.map