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.

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

Update loom to v1 #4544

Merged
merged 2 commits into from
Oct 28, 2021
Merged

Update loom to v1 #4544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad5aa88
Update loom to v1
BPScott Oct 25, 2021
1b7fa6a
Changelog
BPScott Oct 25, 2021
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
2 changes: 2 additions & 0 deletions UNRELEASED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Use [the changelog guidelines](https://git.io/polaris-changelog-guidelines) to f

### Development workflow

- Updated Loom to v1 ([#950](https://github.com/Shopify/global-nav/pull/950))

### Dependency upgrades

### Code quality
Expand Down
6 changes: 4 additions & 2 deletions config/rollup/namespaced-classname.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ const COMPONENT_REGEX = /^[A-Z]\w+$/;
const SUBCOMPONENT_VARIATION_SELECTOR = /^\w+-\w+$/;
const NESTED_COMPONENT_PATH_REGEX = /.*\/components\/(.*)\/components/;

export function generateScopedName({includeHash = false} = {}) {
module.exports.generateScopedName = function generateScopedName({
includeHash = false,
} = {}) {
return (name, filename) => {
const componentName = basename(filename, '.scss');
const nestedComponentMatch = NESTED_COMPONENT_PATH_REGEX.exec(filename);
Expand Down Expand Up @@ -40,7 +42,7 @@ export function generateScopedName({includeHash = false} = {}) {

return className + suffix;
};
}
};

function isComponent(className) {
return COMPONENT_REGEX.test(className);
Expand Down
16 changes: 8 additions & 8 deletions config/rollup/plugin-styles.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import path from 'path';
import {promisify} from 'util';
const path = require('path');
const {promisify} = require('util');

import {createFilter} from '@rollup/pluginutils';
import nodeSass from 'node-sass';
import postcss from 'postcss';
import cssModules from 'postcss-modules';
const {createFilter} = require('@rollup/pluginutils');
const nodeSass = require('node-sass');
const postcss = require('postcss');
const cssModules = require('postcss-modules');

export function styles({
module.exports.styles = function styles({
output = '',
plugins = [],
modules = {},
Expand Down Expand Up @@ -177,7 +177,7 @@ export function styles({
}
},
};
}
};

// We're still using node 10. Array.flat(fn)/Array.flatMap(fn) are added in v11
function flatMap(array, fn) {
Expand Down
72 changes: 26 additions & 46 deletions loom.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
import {
createPackage,
Runtime,
createComposedWorkspacePlugin,
createComposedProjectPlugin,
createWorkspacePlugin,
createProjectPlugin,
DiagnosticError,
} from '@shopify/loom';
import {babel} from '@shopify/loom-plugin-babel';
import {workspaceTypeScript} from '@shopify/loom-plugin-typescript';
import {packageBuild, rollupPlugins} from '@shopify/loom-plugin-package-build';
import {
buildLibrary,
buildLibraryWorkspace,
rollupPlugins,
} from '@shopify/loom-plugin-build-library';
import {eslint} from '@shopify/loom-plugin-eslint';
import {stylelint} from '@shopify/loom-plugin-stylelint';
import {prettier} from '@shopify/loom-plugin-prettier';
import {jest} from '@shopify/loom-plugin-jest';
import replace from '@rollup/plugin-replace';
import image from '@rollup/plugin-image';
import postcssShopify from '@shopify/postcss-plugin';
Expand All @@ -22,57 +20,39 @@ import packageJSON from './package.json';
import {styles} from './config/rollup/plugin-styles';
import {generateScopedName} from './config/rollup/namespaced-classname';

// Needed so TS realises what configutation hooks are provided by Jest
import type {} from '@shopify/loom-plugin-jest';

// eslint-disable-next-line import/no-default-export
export default createPackage((pkg) => {
pkg.runtimes(Runtime.Node, Runtime.Browser);
pkg.entry({root: './src/index'});
pkg.use(libraryPackagePlugin(), libaryWorkspacePlugin());
});

function libraryPackagePlugin() {
return createComposedProjectPlugin('PolarisPackage', [
// this needs to be set here as the current setup cannot
// find the babel.config.js file at the root of the project
babel({
config: {
presets: [['@shopify/babel-preset', {typescript: true, react: true}]],
configFile: false,
},
}),
packageBuild({
browserTargets: 'extends @shopify/browserslist-config',
nodeTargets: 'node 12.20',
pkg.entry({root: './src/index.ts'});
pkg.use(
buildLibrary({
jestTestEnvironment: 'jsdom',
targets: 'extends @shopify/browserslist-config, node 12.20',
commonjs: true,
esmodules: true,
esnext: true,
}),
rollupAdjustPluginsPlugin(),
rollupAdjustOutputPlugin(),
jestAdjustmentsPlugin(),
]);
}

function libaryWorkspacePlugin() {
return createComposedWorkspacePlugin('PolarisWorkspace', [
jest(),
buildLibraryWorkspace(),
eslint(),
stylelint({files: '**/*.scss'}),
prettier({files: '**/*.{md,json,yaml,yml}'}),
workspaceTypeScript(),
rollupAdjustPluginsPlugin(),
rollupAdjustOutputPlugin(),
jestAdjustmentsPlugin(),
preAndPostBuildPlugin(),
]);
}
);
});

function jestAdjustmentsPlugin() {
return createProjectPlugin('PolarisJest', ({tasks: {test}}) => {
return createProjectPlugin('Polaris.Jest', ({tasks: {test}}) => {
test.hook(({hooks}) => {
hooks.configure.hook((configuration) => {
configuration.jestEnvironment?.hook(() => 'jsdom');

// Aliases for root-level imports
// Aliases for root-level imports, which are used in test files
// These do not work in rollup builds, so perhaps we shouldn't configure
// them to work here either
configuration.jestModuleMapper?.hook((moduleMapper) => {
// them to work in jest tests either
configuration.jestModuleNameMapper?.hook((moduleMapper) => {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should everything else follow suit moduleMapper => moduleNameMapper

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the naming of the argument isn't suuuper important as it's highly localised. I think leaving as moduleMapper gets the point across.

moduleMapper['^(components|test-utilities|types|utilities)(.*)'] =
'<rootDir>/src/$1$2';

Expand All @@ -86,7 +66,7 @@ function jestAdjustmentsPlugin() {
}));

// Novel file types - scss and images
configuration.jestTransforms?.hook((transforms) => ({
configuration.jestTransform?.hook((transforms) => ({
...transforms,
'\\.s?css$': require.resolve('./config/jest-transform-style'),
'\\.svg$': require.resolve('./config/jest-transform-image'),
Expand All @@ -97,7 +77,7 @@ function jestAdjustmentsPlugin() {
}

function preAndPostBuildPlugin() {
return createWorkspacePlugin('PolarisExtraBuild', ({api, tasks: {build}}) => {
return createWorkspacePlugin('Polaris.PrePost', ({api, tasks: {build}}) => {
build.hook(({hooks}) => {
hooks.pre.hook((steps) => [
...steps,
Expand Down Expand Up @@ -197,7 +177,7 @@ function rollupAdjustPluginsPlugin() {
* Thus publish our esm files with a .js file extension.
*/
function rollupAdjustOutputPlugin() {
return createProjectPlugin('PolarisJest', ({tasks: {build}}) => {
return createProjectPlugin('Polaris.RollupOutput', ({tasks: {build}}) => {
build.hook(({hooks}) => {
hooks.target.hook(({hooks, target}) => {
const isDefaultBuild = Object.keys(target.options).length === 0;
Expand Down
15 changes: 6 additions & 9 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,15 +98,12 @@
"@shopify/browserslist-config": "^3.0.0",
"@shopify/eslint-plugin": "^39.0.1",
"@shopify/jest-dom-mocks": "^3.0.5",
"@shopify/loom": "^0.7.0",
"@shopify/loom-cli": "^0.7.0",
"@shopify/loom-plugin-babel": "^0.3.0",
"@shopify/loom-plugin-eslint": "^0.5.0",
"@shopify/loom-plugin-jest": "^0.6.0",
"@shopify/loom-plugin-package-build": "^0.7.0",
"@shopify/loom-plugin-prettier": "^0.2.0",
"@shopify/loom-plugin-stylelint": "^0.5.0",
"@shopify/loom-plugin-typescript": "^0.8.0",
"@shopify/loom": "^1.0.0",
"@shopify/loom-cli": "^1.0.0",
"@shopify/loom-plugin-eslint": "^1.0.0",
"@shopify/loom-plugin-build-library": "^1.0.0",
"@shopify/loom-plugin-prettier": "^1.0.0",
"@shopify/loom-plugin-stylelint": "^1.0.0",
"@shopify/postcss-plugin": "^3.1.1",
"@shopify/prettier-config": "^1.1.2",
"@shopify/react-testing": "^3.2.4",
Expand Down
Loading