@smartimpact-it/shopify-disable-features

Shared disabled-features engine, unused-features analyzer, config helpers, derived-state helpers, schema generator, and webpack plugins for Shopify themes.

Installation

Install from the public npm registry:

npm install @smartimpact-it/shopify-disable-features

Consumer usage

Example in a theme repo:

{
  "dependencies": {
    "@smartimpact-it/shopify-disable-features": "^0.1.0"
  }
}

Example type usage in theme-disabled-features.mts:

import type { ThemeSchema } from "./available-schema-fields";
import type {
  FeatureSetup,
  FeatureGroups,
  AlwaysEnabledFeatures,
} from "@smartimpact-it/shopify-disable-features";

export const featureGroups = {} as const satisfies FeatureGroups<ThemeSchema>;
export type FeatureGroupNames = keyof typeof featureGroups;

export const featureSetup: FeatureSetup<ThemeSchema, FeatureGroupNames> = {};
export const alwaysEnabledFeatures: AlwaysEnabledFeatures<ThemeSchema> = {};

Build process

This package is published from generated dist/ output.

• source files stay committed in the repo
• dist/ is generated by npm run build
• dist/ is gitignored and should not be committed
• the published package includes dist/ because package.json -> files points to it

That means:

• local repo checkout: run npm run build if you want to exercise the built package locally
• publish workflow: runs npm run build before npm publish
• consuming repos: install the package tarball from npm, which already contains dist/

npm run verify checks that the built export surface can be imported successfully.

Publishing

Release flow:

npm version patch
git push --follow-tags

Pushing a vX.Y.Z tag triggers .github/workflows/publish-package.yml, which:

• installs dependencies
• builds dist/
• verifies the tag matches package.json version
• creates a GitHub release
• publishes to the public npm registry

The workflow uses:

• GITHUB_TOKEN for the GitHub release
• NPM_TOKEN for npm publishing

NPM_TOKEN should be an npm automation token with publish access to the @smartimpact-it organization.

Exports

Main exports:

• @smartimpact-it/shopify-disable-features
• @smartimpact-it/shopify-disable-features/config
• @smartimpact-it/shopify-disable-features/mutations
• @smartimpact-it/shopify-disable-features/state
• @smartimpact-it/shopify-disable-features/analyzer
• @smartimpact-it/shopify-disable-features/feature-disabler
• @smartimpact-it/shopify-disable-features/schema
• @smartimpact-it/shopify-disable-features/webpack/schema-definitions-plugin
• @smartimpact-it/shopify-disable-features/webpack/extension-data-plugin

CLI binaries

Published bins:

• shopify-disable-features
• shopify-lint-disabled-features
• shopify-disable-unused-features
• shopify-optimize-disabled-features
• shopify-generate-schema-definitions
• shopify-generate-extension-data
• shopify-generate-theme-features-inventory