diff --git a/.travis.yml b/.travis.yml index 37c660aa59..66e7f03b5c 100644 --- a/.travis.yml +++ b/.travis.yml @@ -2,7 +2,7 @@ sudo: false language: node_js node_js: - - 10 + - 13 # Fix build failure. # https://github.com/cypress-io/cypress/issues/4069#issuecomment-488315675 diff --git a/CHANGELOG.md b/CHANGELOG.md index e95971325c..38c959d5da 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,9 @@ ## 0.1.0 - In progress +### Changed +- Changed the bundling process so that subsets of components are bundled into separate JS files by targeting the `src/components/{name}/index.js` files. + ## [0.0.25](https://www.npmjs.com/package/vitessce/v/0.0.25) - 2020-03-26 ### Added - Removed nwb, added custom webpack configuration. diff --git a/README.md b/README.md index 490766640e..955d87e4db 100644 --- a/README.md +++ b/README.md @@ -19,12 +19,70 @@ For more information, see the [documentation](http://vitessce.io/prod-docs/index The demo features data from several collaborators, with preprocessing done by [`vitessce-data`](https://github.com/hms-dbmi/vitessce-data). +## Usage + +Vitessce components can be used in React projects by installing the package from NPM: + +```sh +npm install vitessce +``` + +The following code demonstrates the `` and `` components. + +Note the `vitessce-container` and `vitessce-theme-light` classes added to the parent `div` element. +Vitessce component styles are scoped under these classes, which means that a parent element must apply the classes in order for child components to inherit the expected styles. + +```jsx +import React from 'react'; +import { Scatterplot } from 'vitessce/es/production/scatterplot.min.js'; +import { Status } from 'vitessce/es/production/status.min.js'; +import 'vitessce/es/production/static/css/index.css'; + +export default function App() { + const view = { target: [0, 0, 0], zoom: 0.75 }; + const mapping = "PCA"; + const cells = { + 1: { mappings: { [mapping]: [0, 0] } }, + 2: { mappings: { [mapping]: [1, 1] } }, + 3: { mappings: { [mapping]: [1, 2] } } + }; + const selectedCellIds = new Set(); + const dimensions = { width: '400px', height: '400px', margin: '10px' }; + + return ( +
+
+ {}} + /> +
+
+ {}} + updateCellsSelection={(selectedIds) => {}} + updateCellsHover={(hoverInfo) => {}} + updateViewInfo={(viewInfo) => {}} + clearPleaseWait={(layerName) => {}} + /> +
+
+ ); +} +``` + ## Development -First check your NodeJS version: It should work with NodeJS 8 or 10; it will [fail with NodeJS 12](https://github.com/hubmapconsortium/vitessce/issues/379). +First check your NodeJS version: It should work with NodeJS 8, 10, 12, or 13. ``` $ node --version -v10.17.0 +v13.13.0 ``` Checkout the project, `cd`, and then: diff --git a/config/env.js b/config/env.js deleted file mode 100644 index 18ad67dc38..0000000000 --- a/config/env.js +++ /dev/null @@ -1,106 +0,0 @@ -/* - * This file has been ejected from create-react-app v3.4.0. - * It has not been touched since then (if you edit this file please amend this message). - */ - -'use strict'; - -const fs = require('fs'); -const path = require('path'); -const paths = require('./paths'); - -// Make sure that including paths.js after env.js will read .env variables. -delete require.cache[require.resolve('./paths')]; - -const NODE_ENV = process.env.NODE_ENV; -if (!NODE_ENV) { - throw new Error( - 'The NODE_ENV environment variable is required but was not specified.' - ); -} - -// https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use -const dotenvFiles = [ - `${paths.dotenv}.${NODE_ENV}.local`, - `${paths.dotenv}.${NODE_ENV}`, - // Don't include `.env.local` for `test` environment - // since normally you expect tests to produce the same - // results for everyone - NODE_ENV !== 'test' && `${paths.dotenv}.local`, - paths.dotenv, -].filter(Boolean); - -// Load environment variables from .env* files. Suppress warnings using silent -// if this file is missing. dotenv will never modify any environment variables -// that have already been set. Variable expansion is supported in .env files. -// https://github.com/motdotla/dotenv -// https://github.com/motdotla/dotenv-expand -dotenvFiles.forEach(dotenvFile => { - if (fs.existsSync(dotenvFile)) { - require('dotenv-expand')( - require('dotenv').config({ - path: dotenvFile, - }) - ); - } -}); - -// We support resolving modules according to `NODE_PATH`. -// This lets you use absolute paths in imports inside large monorepos: -// https://github.com/facebook/create-react-app/issues/253. -// It works similar to `NODE_PATH` in Node itself: -// https://nodejs.org/api/modules.html#modules_loading_from_the_global_folders -// Note that unlike in Node, only *relative* paths from `NODE_PATH` are honored. -// Otherwise, we risk importing Node.js core modules into an app instead of webpack shims. -// https://github.com/facebook/create-react-app/issues/1023#issuecomment-265344421 -// We also resolve them to make sure all tools using them work consistently. -const appDirectory = fs.realpathSync(process.cwd()); -process.env.NODE_PATH = (process.env.NODE_PATH || '') - .split(path.delimiter) - .filter(folder => folder && !path.isAbsolute(folder)) - .map(folder => path.resolve(appDirectory, folder)) - .join(path.delimiter); - -// Grab NODE_ENV and REACT_APP_* environment variables and prepare them to be -// injected into the application via DefinePlugin in webpack configuration. -const REACT_APP = /^REACT_APP_/i; - -function getClientEnvironment(publicUrl) { - const raw = Object.keys(process.env) - .filter(key => REACT_APP.test(key)) - .reduce( - (env, key) => { - env[key] = process.env[key]; - return env; - }, - { - // Useful for determining whether we’re running in production mode. - // Most importantly, it switches React into the correct mode. - NODE_ENV: process.env.NODE_ENV || 'development', - // Useful for resolving the correct path to static assets in `public`. - // For example, . - // This should only be used as an escape hatch. Normally you would put - // images into the `src` and `import` them in code to get their paths. - PUBLIC_URL: publicUrl, - // We support configuring the sockjs pathname during development. - // These settings let a developer run multiple simultaneous projects. - // They are used as the connection `hostname`, `pathname` and `port` - // in webpackHotDevClient. They are used as the `sockHost`, `sockPath` - // and `sockPort` options in webpack-dev-server. - WDS_SOCKET_HOST: process.env.WDS_SOCKET_HOST, - WDS_SOCKET_PATH: process.env.WDS_SOCKET_PATH, - WDS_SOCKET_PORT: process.env.WDS_SOCKET_PORT, - } - ); - // Stringify all values so we can feed into webpack DefinePlugin - const stringified = { - 'process.env': Object.keys(raw).reduce((env, key) => { - env[key] = JSON.stringify(raw[key]); - return env; - }, {}), - }; - - return { raw, stringified }; -} - -module.exports = getClientEnvironment; diff --git a/config/modules.js b/config/modules.js deleted file mode 100644 index 9c71b99f67..0000000000 --- a/config/modules.js +++ /dev/null @@ -1,124 +0,0 @@ -/* - * This file has been ejected from create-react-app v3.4.0. - * It has been slightly modified to remove code related to the `jest` testing library. - */ - -'use strict'; - -const fs = require('fs'); -const path = require('path'); -const paths = require('./paths'); -const chalk = require('react-dev-utils/chalk'); -const resolve = require('resolve'); - -/** - * Get additional module paths based on the baseUrl of a compilerOptions object. - * - * @param {Object} options - */ -function getAdditionalModulePaths(options = {}) { - const baseUrl = options.baseUrl; - - // We need to explicitly check for null and undefined (and not a falsy value) because - // TypeScript treats an empty string as `.`. - if (baseUrl == null) { - // If there's no baseUrl set we respect NODE_PATH - // Note that NODE_PATH is deprecated and will be removed - // in the next major release of create-react-app. - - const nodePath = process.env.NODE_PATH || ''; - return nodePath.split(path.delimiter).filter(Boolean); - } - - const baseUrlResolved = path.resolve(paths.appPath, baseUrl); - - // We don't need to do anything if `baseUrl` is set to `node_modules`. This is - // the default behavior. - if (path.relative(paths.appNodeModules, baseUrlResolved) === '') { - return null; - } - - // Allow the user set the `baseUrl` to `appSrc`. - if (path.relative(paths.appSrc, baseUrlResolved) === '') { - return [paths.appSrc]; - } - - // If the path is equal to the root directory we ignore it here. - // We don't want to allow importing from the root directly as source files are - // not transpiled outside of `src`. We do allow importing them with the - // absolute path (e.g. `src/Components/Button.js`) but we set that up with - // an alias. - if (path.relative(paths.appPath, baseUrlResolved) === '') { - return null; - } - - // Otherwise, throw an error. - throw new Error( - chalk.red.bold( - "Your project's `baseUrl` can only be set to `src` or `node_modules`." + - ' Create React App does not support other values at this time.' - ) - ); -} - -/** - * Get webpack aliases based on the baseUrl of a compilerOptions object. - * - * @param {*} options - */ -function getWebpackAliases(options = {}) { - const baseUrl = options.baseUrl; - - if (!baseUrl) { - return {}; - } - - const baseUrlResolved = path.resolve(paths.appPath, baseUrl); - - if (path.relative(paths.appPath, baseUrlResolved) === '') { - return { - src: paths.appSrc, - }; - } -} - -function getModules() { - // Check if TypeScript is setup - const hasTsConfig = fs.existsSync(paths.appTsConfig); - const hasJsConfig = fs.existsSync(paths.appJsConfig); - - if (hasTsConfig && hasJsConfig) { - throw new Error( - 'You have both a tsconfig.json and a jsconfig.json. If you are using TypeScript please remove your jsconfig.json file.' - ); - } - - let config; - - // If there's a tsconfig.json we assume it's a - // TypeScript project and set up the config - // based on tsconfig.json - if (hasTsConfig) { - const ts = require(resolve.sync('typescript', { - basedir: paths.appNodeModules, - })); - config = ts.readConfigFile(paths.appTsConfig, ts.sys.readFile).config; - // Otherwise we'll check if there is jsconfig.json - // for non TS projects. - } else if (hasJsConfig) { - config = require(paths.appJsConfig); - } - - config = config || {}; - const options = config.compilerOptions || {}; - - const additionalModulePaths = getAdditionalModulePaths(options); - - return { - additionalModulePaths: additionalModulePaths, - webpackAliases: getWebpackAliases(options), - hasTsConfig, - }; -} - -module.exports = getModules(); diff --git a/config/paths.js b/config/paths.js deleted file mode 100644 index 1d1db4b7ac..0000000000 --- a/config/paths.js +++ /dev/null @@ -1,57 +0,0 @@ -/* - * This file has been ejected from create-react-app v3.4.0. - * The paths have been modified, and the `libBuild` and `libIndexJs` paths have been added. - * Rather than using the `homepage` property from `package.json` we now use "." to ensure - * that relative paths are used for