Skip to content

feat(extensions): handle build step for expressjs framework - #1315

Open
canon-cat wants to merge 4 commits into
canonical:mainfrom
canon-cat:proto-isd293-v2
Open

feat(extensions): handle build step for expressjs framework#1315
canon-cat wants to merge 4 commits into
canonical:mainfrom
canon-cat:proto-isd293-v2

Conversation

@canon-cat

Copy link
Copy Markdown
Contributor

These changes introduce support for build step that may be defined in package.json file (typescript, vite, etc.)

Note: it requires PR#1310 to pass all tests.

  • I've followed the contribution guidelines.
  • I've signed the CLA.
  • I've successfully run make lint && make test.
  • I've added or updated any relevant documentation.
  • In documents I changed, I added a meta description if one was missing.
  • I've updated the relevant release notes.

@canon-cat
canon-cat requested review from a team, asanvaq and tigarmo as code owners July 30, 2026 11:40

@asanvaq asanvaq left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks! From the documentation side, I have added a few comments.

It facilitates the installation of Express application dependencies, including
Node.js and npm, inside the rock. Additionally, it transfers your project files
to ``/app`` within the rock.
Node.js and npm, inside the rock. Extension discovers location of the

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Node.js and npm, inside the rock. Extension discovers location of the
Node.js and npm, inside the rock. The extension discovers the location of the

Node.js and npm, inside the rock. Additionally, it transfers your project files
to ``/app`` within the rock.
Node.js and npm, inside the rock. Extension discovers location of the
``package.json``, but can only package a single application. If application

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
``package.json``, but can only package a single application. If application
``package.json``, but can only package a single application. If the application

to ``/app`` within the rock.
Node.js and npm, inside the rock. Extension discovers location of the
``package.json``, but can only package a single application. If application
defines ``build`` script, development dependencies will be installed,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Usage of "a" or "the" depends on if there is only one specific build script or not. Which case is this?

Suggested change
defines ``build`` script, development dependencies will be installed,
defines a ``build`` script, development dependencies will be installed,

Node.js and npm, inside the rock. Extension discovers location of the
``package.json``, but can only package a single application. If application
defines ``build`` script, development dependencies will be installed,
``npm run build`` called, and entries matching ``file`` array (excluding

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Adding verb for consistency with the other two items.

Suggested change
``npm run build`` called, and entries matching ``file`` array (excluding
``npm run build`` will be called, and entries matching ``file`` array (excluding

``package.json``, but can only package a single application. If application
defines ``build`` script, development dependencies will be installed,
``npm run build`` called, and entries matching ``file`` array (excluding
entries from ``.npmignore``, if exists) will be packages. If ``files``

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
entries from ``.npmignore``, if exists) will be packages. If ``files``
entries from ``.npmignore``, if they exist) will be packages. If the ``files``

2. The ``package.json`` file should define the ``start`` script.
For more information, see the `npm documentation <https://docs.npmjs.com/cli/v11/configuring-npm/package-json>`_.

If application defines ``build`` script in ``package.json`` file, it is

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

For using "a" or "the" in front of build script, see comment above.

Suggested change
If application defines ``build`` script in ``package.json`` file, it is
If the application defines a ``build`` script in ``package.json`` file, it is

For more information, see the `npm documentation <https://docs.npmjs.com/cli/v11/configuring-npm/package-json>`_.

If application defines ``build`` script in ``package.json`` file, it is
recommended to have ``files`` array describing the entries to be included

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
recommended to have ``files`` array describing the entries to be included
recommended to have a ``files`` array describing the entries to be included

If application defines ``build`` script in ``package.json`` file, it is
recommended to have ``files`` array describing the entries to be included
or have an appropriate ``.npmignore`` file to exclude entries not required
at the run time. If ``files`` array is not defined and ``.npmignore``

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
at the run time. If ``files`` array is not defined and ``.npmignore``
at the run time. If the ``files`` array is not defined and ``.npmignore``

@asanvaq

asanvaq commented Aug 2, 2026

Copy link
Copy Markdown
Collaborator

Pinging @erinecon for review!

@asanvaq
asanvaq requested a review from erinecon August 2, 2026 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants