Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(formats): add javascript/es6-ts-declarations formats for .d.ts #467

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions __tests__/formats/__snapshots__/all.test.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,15 @@ exports[`formats all should match javascript/es6 snapshot 1`] = `
export const color_red = \\"#FF0000\\"; // comment"
`;

exports[`formats all should match javascript/es6-ts-declarations snapshot 1`] = `
"/**
* Do not edit directly
* Generated on Sat, 01 Jan 2000 00:00:00 GMT
*/

export const color_red : string; // comment"
`;

exports[`formats all should match javascript/module snapshot 1`] = `
"/**
* Do not edit directly
Expand Down
77 changes: 77 additions & 0 deletions __tests__/formats/es6TypeScriptDeclarations.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
/*
* Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
var fs = require('fs-extra');
var helpers = require('../__helpers');
var formats = require('../../lib/common/formats');

var file = {
"destination": "__output/",
"format": "javascript/es6-ts-declarations",
"filter": {
"attributes": {
"category": "color"
}
}
};

var dictionary = {
"allProperties": [{
"name": "red",
"value": "#EF5350",
"original": {
"value": "#EF5350"
},
"attributes": {
"category": "color",
"type": "base",
"item": "red",
"subitem": "400"
},
"path": [
"color",
"base",
"red",
"400"
]
}]
};

var formatter = formats['javascript/es6-ts-declarations'].bind(file);

describe('formats', () => {
describe('javascript/es6-ts-declarations', () => {
beforeEach(() => {
helpers.clearOutput();
});

afterEach(() => {
helpers.clearOutput();
});

it('should be a valid JS file', () => {
const declarations = './__tests__/__output/output.d.ts';
fs.writeFileSync(declarations, formatter(dictionary) );

// get all lines that begin with export
const lines = fs.readFileSync(declarations, 'utf-8')
.split('\n')
.filter(l => l.indexOf('export') >= 0);

// assert that any lines have a string type definition
lines.forEach(l => {
expect(l.match(/^export.* : string;$/g).length).toEqual(1);
});
});
});

});
36 changes: 36 additions & 0 deletions lib/common/formats.js
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,42 @@ module.exports = {
return to_ret_prop;
}).join('\n');
},
/**
* Creates TypeScript declarations for ES6 modules
*
* ```json
* {
* "platforms": {
* "js": {
* "transformGroup": "js",
* "files": [
* {
* "format": "javascript/es6-ts-declarations",
* "destination": "colors.d.ts"
* }
* ]
* }
* }
* }
* ```
*
* @memberof Formats
* @kind member
* @example
* ```js
* export const ColorBackgroundBase : string;
* export const ColorBackgroundAlt : string;
* ```
*/
'javascript/es6-ts-declarations': function(dictionary) {
return fileHeader(this.options) +
dictionary.allProperties.map(function(prop) {
var to_ret_prop = 'export const ' + prop.name + ' : string;';
if (prop.comment)
to_ret_prop = to_ret_prop.concat(' // ' + prop.comment);
return to_ret_prop;
}).join('\n');
},

// Android templates
/**
Expand Down