This project was bootstrapped with @enact/cli.
Below you will find some information on how to perform common tasks. You can find the most recent version of this guide here. Additional documentation on @enact/cli can be found here.
After creation, your project should look like this:
my-app/
README.md
.gitignore
node_modules/
package.json
src/
App/
App.js
App.less
package.json
components/
views/
MainPanel.js
index.js
resources/
For the project to build, these files must exist with exact filenames:
package.json
is the core package manifest for the projectsrc/index.js
is the JavaScript entry point.
You can delete or rename the other files.
You can update the license
entry in package.json
to match the license of your choice. For more
information on licenses, please see the npm documentation.
In the project directory, you can run:
Builds and serves the app in the development mode.
Open http://localhost:8080 to view it in the browser.
The page will reload if you make edits.
Builds the project in the working directory. Specifically, pack
builds in development mode with code un-minified and with debug code included, whereas pack-p
builds in production mode, with everything minified and optimized for performance. Be sure to avoid shipping or performance testing on development mode builds.
Builds the project in development mode and keeps watch over the project directory. Whenever files are changed, added, or deleted, the project will automatically get rebuilt using an active shared cache to speed up the process. This is similar to the serve
task, but without the http server.
Deletes previous build fragments from ./dist.
Runs the Enact configuration of Eslint on the project for syntax analysis.
These tasks will execute all valid tests (files that end in -specs.js
) that are within the project directory. The test
is a standard single execution pass, while test-watch
will set up a watcher to re-execute tests when files change.
The @enact/cli tool will check the project's package.json
looking for an optional enact
object for a few customization options:
template
[string] - Filepath to an alternate HTML template to use with the Webpack html-webpack-plugin.isomorphic
[string] - Alternate filepath to a custom isomorphic-compatible entry point. Not needed if main entry point is already isomorphic-compatible.title
[string] - Title text that should be put within the HTML's<title></title>
tags. Note: if this is a webOS-project, the title will, by default, be auto-detected from the appinfo.json content.theme
[object] - A simplified string name to extrapolatefontGenerator
,ri
, andscreenTypes
preset values from. For example,"sandstone"
.fontGenerator
[string] - Filepath to a CommonJS fontGenerator module which will build locale-specific font CSS to inject into the HTML. By default, will use any preset for a specified theme or fallback to sandstone.ri
[object] - Resolution independence options to be forwarded to the LESS plugin. By default, will use any preset for a specified theme or fallback to sandstone.screenTypes
[array|string] - Array of 1 or more screentype definitions to be used with prerender HTML initialization. Can alternatively reference a json filepath to read for screentype definitions. By default, will use any preset for a specified theme or fallback to sandstone.nodeBuiltins
[object] - Configuration settings for polyfilling NodeJS built-ins. Seenode
webpack option.deep
[string|array] - 1 or more JavaScript conditions that, when met, indicate deeplinking and any prerender should be discarded.target
[string|array] - A build-type generic preset string (seetarget
webpack option) or alternatively a specific browserslist array of desired targets.proxy
[string] - Proxy target during projectserve
to be used within the http-proxy-middleware.
For example:
{
...
"enact": {
"theme": "sandstone",
"nodeBuiltins": {
fs: 'empty',
net: 'empty',
tls: 'empty'
}
}
...
}
Some editors, including Sublime Text, Atom, and Visual Studio Code, provide plugins for ESLint.
They are not required for linting. You should see the linter output right in your terminal as well as the browser console. However, if you prefer the lint results to appear right in your editor, there are some extra steps you can do.
You would need to install an ESLint plugin for your editor first.
Ever since ESLint 6, global installs of ESLint configs are no longer supported. To work around this new limitation, while still supporting in-editor linting, we've created a new eslint-config-enact-proxy package. The eslint-config-enact-proxy acts like a small proxy config, redirecting ESLint to use a globally-installed Enact ESLint config. In order for in-editor linting to work with our updated ESLint config, you'll need to upgrade to ESLint 7 or later. This can be installed globally by running:
npm install -g eslint
Then, you will need to uninstall any previous globally-installed Enact linting package (everything but eslint itself):
npm remove -g eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-babel babel-eslint eslint-plugin-jest eslint-plugin-enact eslint-config-enact
The generated project includes Enact (and all its libraries). It also includes React and ReactDOM. For test writing, both Sinon and Enzyme are as development dependencies. You may install other dependencies with npm
:
npm install --save <package-name>
This project setup supports ES6 modules thanks to Babel.
While you can still use require()
and module.exports
, we encourage you to use import
and export
instead.
For example:
import kind from '@enact/core/kind';
const Button = kind({
render() {
// ...
}
});
export default Button; // Don’t forget to use export default!
import kind from '@enact/core/kind';
import Button from './Button'; // Import a component from another file
const DangerButton = kind({
render(props) {
return <Button {...props} color="red" />;
}
});
export default DangerButton;
Be aware of the difference between default and named exports. It is a common source of mistakes.
We suggest that you stick to using default imports and exports when a module only exports a single thing (for example, a component). That’s what you get when you use export default Button
and import Button from './Button'
.
Named exports are useful for utility modules that export several functions. A module may have at most one default export and as many named exports as you like.
Learn more about ES6 modules:
This project setup uses Webpack for handling all assets. Webpack offers a custom way of “extending” the concept of import
beyond JavaScript. To express that a JavaScript file depends on a LESS/CSS file, you need to import the CSS from the JavaScript file:
.button {
padding: 20px;
}
import kind from '@enact/core/kind';
import styles './Button.css'; // Tell Webpack that Button.js uses these styles
const Button = kind({
render() {
// You can use them as regular CSS styles
return <div className={styles['button']} />;
}
}
Upon importing a css/less files, the resulting object will be a mapping of class names from that document. This allows correct access to the class name string regardless how the build process mangles it up.
In development, expressing dependencies this way allows your styles to be reloaded on the fly as you edit them. In production, all CSS files will be concatenated into a single minified .css
file in the build output.
Additionally, this system setup supports CSS module spec with allows for compositional CSS classes and inheritance of styles.
With Webpack, using static assets like images and fonts works similarly to CSS.
You can import
an image right in a JavaScript module. This tells Webpack to include that image in the bundle. Unlike CSS imports, importing an image or a font gives you a string value. This value is the final image path you can reference in your code.
Here is an example:
import kind from '@enact/core/kind';
import logo from './logo.png'; // Tell Webpack this JS file uses this image
console.log(logo); // /logo.84287d09.png
const Header = kind({
render: function() {
// Import result is the URL of your image
return <img src={logo} alt="Logo" />;
}
});
export default Header;
This is currently required for local images. This ensures that when the project is built, webpack will correctly move the images into the build folder, and provide us with correct paths.
This works in LESS/CSS too:
.logo {
background-image: url(./logo.png);
}
Webpack finds all relative module references in CSS (they start with ./
) and replaces them with the final paths from the compiled bundle. If you make a typo or accidentally delete an important file, you will see a compilation error, just like when you import a non-existent JavaScript module. The final filenames in the compiled bundle are generated by Webpack from content hashes.