Skip to content

Fix library's imported name using requirejs AMD loader #6440

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.

Sign up for GitHub

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

Merged
merged 7 commits into from
Jan 18, 2023
Merged

Fix library's imported name using requirejs AMD loader #6440

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
16f1d1f
set umdNamedDefine to false - fix AMD import in docs
archmoj Jan 17, 2023
f23051a
set umdNamedDefine to false in dashboard & karma config
archmoj Jan 17, 2023
5499547
use centralized webpack config.output.library options
archmoj Jan 18, 2023
e32ba76
rename requirejs to amdefine test then add new requirejs test
archmoj Jan 18, 2023
40cecb6
draft log for PR 6440
archmoj Jan 18, 2023
4fd73a7
Update devtools/test_dashboard/server.js
archmoj Jan 18, 2023
9da2ce0
fixup Tabs
archmoj Jan 18, 2023
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
3 changes: 3 additions & 0 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,9 @@ jobs:
- run:
name: Test plot-schema.json diff - If failed, after (npm start) you could run (npm run schema && git add test/plot-schema.json && git commit -m "update plot-schema diff")
command: diff --unified --color dist/plot-schema.json test/plot-schema.json
- run:
name: Test plotly.min.js import using amdefine
command: npm run test-amdefine
- run:
name: Test plotly.min.js import using requirejs
command: npm run test-requirejs
Expand Down
1 change: 1 addition & 0 deletions .eslintignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ node_modules
dist
build

tasks/test_amdefine.js
tasks/test_requirejs.js
test/jasmine/assets/jquery-1.8.3.min.js
6 changes: 1 addition & 5 deletions devtools/test_dashboard/server.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,7 @@ devtoolsConfig.entry = path.join(devtoolsPath, 'devtools.js');
devtoolsConfig.output = {
path: config.output.path,
filename: 'test_dashboard-bundle.js',
library: {
name: 'Tabs',
type: 'umd',
umdNamedDefine: true
}
library: config.output.library
};

devtoolsConfig.target = config.target;
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
"test-export": "node test/image/export_test.js",
"test-syntax": "node tasks/test_syntax.js && npm run find-strings -- --no-output",
"test-bundle": "node tasks/test_bundle.js",
"test-amdefine": "node tasks/test_amdefine.js",
"test-requirejs": "node tasks/test_requirejs.js",
"test-plain-obj": "node tasks/test_plain_obj.js",
"test": "npm run test-jasmine -- --nowatch && npm run test-bundle && npm run test-image && npm run test-export && npm run test-syntax && npm run lint",
Expand Down
28 changes: 28 additions & 0 deletions tasks/test_amdefine.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
var JSDOM = require('jsdom').JSDOM;
global.document = new JSDOM('<!DOCTYPE html><head></head><html><body></body></html>').window.document;
global.window = document.defaultView;
global.window.document = global.document;
global.self = global.window;
global.Blob = global.window.Blob;
global.DOMParser = global.window.DOMParser;
global.getComputedStyle = global.window.getComputedStyle;
global.window.URL.createObjectURL = function() {};

// see: Building node modules with AMD or RequireJS https://requirejs.org/docs/node.html
if(typeof define !== 'function') {
var define = require('amdefine')(module);
}

define(function(require) {
var plotly = require('../dist/plotly.min.js');

if(plotly) {
console.log(plotly);
} else {
throw 'Error: loading with amdefine';
}

// The value returned from the function is
// used as the module export visible to Node.
return function() {};
});
18 changes: 8 additions & 10 deletions tasks/test_requirejs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,19 @@ global.DOMParser = global.window.DOMParser;
global.getComputedStyle = global.window.getComputedStyle;
global.window.URL.createObjectURL = function() {};

// see: Building node modules with AMD or RequireJS https://requirejs.org/docs/node.html
if(typeof define !== 'function') {
var define = require('amdefine')(module);
}
var requirejs = require('requirejs');

define(function(require) {
var plotly = require('../dist/plotly.min.js');
requirejs.config({
paths: {
'plotly': '../dist/plotly.min'
}
});

requirejs(['plotly'],
function(plotly) {
if(plotly) {
console.log(plotly);
} else {
throw 'Error: loading with requirejs';
}

// The value returned from the function is
// used as the module export visible to Node.
return function() {};
});
7 changes: 2 additions & 5 deletions test/jasmine/karma.conf.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ var minimist = require('minimist');
var NodePolyfillPlugin = require('node-polyfill-webpack-plugin');
var LoaderOptionsPlugin = require('webpack').LoaderOptionsPlugin;
var constants = require('../../tasks/util/constants');
var webpackConfig = require('../../webpack.config.js');

var isCI = Boolean(process.env.CI);

Expand Down Expand Up @@ -298,11 +299,7 @@ func.defaultConfig = {
new LoaderOptionsPlugin({
// test: /\.xxx$/, // may apply this only for some modules
options: {
library: {
name: 'Plotly',
type: 'umd',
umdNamedDefine: true
}
library: webpackConfig.output.library
}
})
]
Expand Down
2 changes: 1 addition & 1 deletion webpack.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ module.exports = {
library: {
name: 'Plotly',
type: 'umd',
umdNamedDefine: true
umdNamedDefine: false
}
},
module: {
Expand Down