Skip to content

Commit 037d287

Browse files
kgrytekgryte
committed
Refactor as package which returns the absolute path of TypeScript declarations
1 parent c4afeaf commit 037d287

File tree

7 files changed

+198
-3
lines changed

7 files changed

+198
-3
lines changed

‎lib/node_modules/@stdlib/types/examples/index.js‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2021 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
var dir = require( './../lib' );
22+
23+
console.log( dir );
24+
// => <string>

lib/node_modules/@stdlib/types/index.js renamed to lib/node_modules/@stdlib/types/lib/browser.js

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @license Apache-2.0
33
*
4-
* Copyright (c) 2019 The Stdlib Authors.
4+
* Copyright (c) 2021 The Stdlib Authors.
55
*
66
* Licensed under the Apache License, Version 2.0 (the "License");
77
* you may not use this file except in compliance with the License.
@@ -15,3 +15,14 @@
1515
* See the License for the specific language governing permissions and
1616
* limitations under the License.
1717
*/
18+
19+
'use strict';
20+
21+
// MAIN //
22+
23+
var dir = null;
24+
25+
26+
// EXPORTS //
27+
28+
module.exports = dir;

‎lib/node_modules/@stdlib/types/lib/index.js‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2021 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
/**
22+
* Absolute file path for the directory containing TypeScript declarations.
23+
*
24+
* @module @stdlib/types
25+
*
26+
* @example
27+
* var dir = require( '@stdlib/types' );
28+
*
29+
* console.log( dir );
30+
*/
31+
32+
// MODULES //
33+
34+
var dir = require( './main.js' );
35+
36+
37+
// EXPORTS //
38+
39+
module.exports = dir;

‎lib/node_modules/@stdlib/types/lib/main.js‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2019 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MAIN //
22+
23+
/**
24+
* Absolute file path for the directory containing type declarations.
25+
*
26+
* @name dir
27+
* @constant
28+
* @type {string}
29+
*/
30+
var dir = __dirname;
31+
32+
33+
// EXPORTS //
34+
35+
module.exports = dir;

‎lib/node_modules/@stdlib/types/package.json‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,13 @@
1313
"url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
1414
}
1515
],
16-
"main": ".",
17-
"directories": {},
16+
"main": "./lib",
17+
"browser": "./lib/browser.js",
18+
"directories": {
19+
"example": "./examples",
20+
"lib": "./lib",
21+
"test": "./test"
22+
},
1823
"types": ".",
1924
"scripts": {},
2025
"homepage": "https://github.com/stdlib-js/stdlib",

‎lib/node_modules/@stdlib/types/test/test.browser.js‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2021 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var tape = require( 'tape' );
24+
var dir = require( './../lib/browser.js' );
25+
26+
27+
// TESTS //
28+
29+
tape( 'main export is a null', function test( t ) {
30+
t.ok( true, __filename );
31+
t.strictEqual( dir, null, 'main export is null' );
32+
t.end();
33+
});

‎lib/node_modules/@stdlib/types/test/test.js‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2021 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var resolve = require( 'path' ).resolve;
24+
var tape = require( 'tape' );
25+
var IS_BROWSER = require( '@stdlib/assert/is-browser' );
26+
var dir = require( './../lib' );
27+
28+
29+
// VARIABLES //
30+
31+
var opts = {
32+
'skip': IS_BROWSER
33+
};
34+
35+
36+
// TESTS //
37+
38+
tape( 'main export is a string', opts, function test( t ) {
39+
t.ok( true, __filename );
40+
t.strictEqual( typeof dir, 'string', 'main export is a string' );
41+
t.end();
42+
});
43+
44+
tape( 'the exported value corresponds to the package directory containing type declarations', opts, function test( t ) {
45+
var expected = resolve( __dirname, '..' );
46+
t.strictEqual( dir, expected, 'exports expected value' );
47+
t.end();
48+
});

0 commit comments

Comments
 (0)