newspack-scripts 1.7.0-alpha.2 → 2.0.0

package/.github/ISSUE_TEMPLATE/Bug_report.md

@@ -0,0 +1,21 @@
+---
+name: "\U0001F41E Bug report"
+about: Report a bug if something isn't working as expected.
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is. Please be as descriptive as possible; issues lacking detail, or for any other reason than to report a bug, may be closed without action.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.

package/.github/ISSUE_TEMPLATE/Enhancement.md

@@ -0,0 +1,17 @@
+---
+name: "✨ New Enhancement"
+about: "If you have an idea to improve an existing feature please let us know or submit a Pull Request!"
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/.github/ISSUE_TEMPLATE/Feature_request.md

@@ -0,0 +1,17 @@
+---
+name: "\U0001F680 Feature request"
+about: "Suggest a new feature \U0001F389 We'll consider building it if it receives sufficient interest! \U0001F44D"
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,28 @@
+### All Submissions:
+
+* [ ] Have you followed the [Newspack Contributing guideline](https://github.com/Automattic/newspack-theme/blob/master/.github/CONTRIBUTING.md)?
+* [ ] Have you checked to ensure there aren't other open [Pull Requests](../../pulls) for the same update/change?
+
+<!-- Mark completed items with an [x] -->
+
+<!-- You can erase any parts of this template not applicable to your Pull Request. -->
+
+### Changes proposed in this Pull Request:
+
+<!-- Describe the changes made to this Pull Request, and the reason for such changes. -->
+
+Closes # .
+
+### How to test the changes in this Pull Request:
+
+1.
+2.
+3.
+
+### Other information:
+
+* [ ] Have you added an explanation of what your changes do and why you'd like us to include them?
+* [ ] Have you written new tests for your changes, as applicable?
+* [ ] Have you successfully ran tests with your changes locally?
+
+<!-- Mark completed items with an [x] -->

package/.github/dependabot.yml

@@ -0,0 +1,27 @@
+# Dependabot config.
+# Keep NPM and Composer packages up-to-date.
+# Let's start out with weekly updates and then drop back to less frequent intervals after everything is up-to-date.
+
+version: 2
+updates:
+  # Enable version updates for npm
+  - package-ecosystem: 'npm'
+    # Look for `package.json` and `lock` files in the `root` directory
+    directory: '/'
+    # Check the npm registry for updates every day (weekdays)
+    schedule:
+      interval: 'weekly'
+    # Add reviewers
+    reviewers:
+      - 'Automattic/newspack-product'
+
+  # Enable version updates for Composer
+  - package-ecosystem: 'composer'
+    # Look for a `composer.lock` in the `root` directory
+    directory: '/'
+    # Check for updates every day (weekdays)
+    schedule:
+      interval: 'weekly'
+    # Add reviewers
+    reviewers:
+      - 'Automattic/newspack-product'

package/.github/workflows/auto-merge.yml

@@ -0,0 +1,18 @@
+on:
+  pull_request_target:
+    types: [labeled]
+
+name: Dependabot auto-merge
+jobs:
+  auto-merge:
+    name: Auto-merge dependabot PRs for minor and patch updates
+    runs-on: ubuntu-latest
+    if: |
+      contains( github.event.pull_request.labels.*.name, 'dependencies' )
+      && ! contains( github.event.pull_request.labels.*.name, '[Status] Approved' )
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ahmadnassri/action-dependabot-auto-merge@v2
+        with:
+          target: minor # includes patch updates.
+          github-token: ${{ secrets.DEPENDABOT_TOKEN }}

package/.github/workflows/main.yml

@@ -0,0 +1,15 @@
+on: pull_request_review
+name: Label approved pull requests
+jobs:
+  labelWhenApproved:
+    name: Label when approved
+    runs-on: ubuntu-latest
+    steps:
+      - name: Label when approved
+        uses: pullreminders/label-when-approved-action@master
+        env:
+          APPROVALS: '1'
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          ADD_LABEL: '[Status] Approved'
+          # Needs to be URL-encoded, see https://github.com/abinoda/label-when-approved-action/pull/3#discussion_r321882620
+          REMOVE_LABEL: '%5BStatus%5D%20Needs%20Review'

package/README.md

@@ -2,6 +2,8 @@
 
 Scripts for Newspack, heavily inspired by [`react-scripts`](https://github.com/facebook/create-react-app/blob/main/packages/react-scripts).
 
+---
+
 ## Available scripts
 
 ### test
@@ -15,7 +17,7 @@ Will run `jest` tests. Useful flags:
 
 Will run `calypso-build`, creating optimised production builds.
 
-### start
+### watch
 
 Will run `calypso-build` in watch mode.
 
@@ -31,6 +33,8 @@ Lints to commit message, to be used in a git `commit-msg` hook.
 
 Will run [`semantic-release`](semantic-release.gitbook.io/) based on a very opinionated configuration.
 
+---
+
 ## Available configs
 
 This package exposes a couple of configuration files.
@@ -89,3 +93,11 @@ stylelint '**/*.scss' --syntax scss --config=./node_modules/newspack-scripts/con
 ```
 
 _Note: Due to issue with dependency resolving, you might end up a different version of `prettier` in project's `node_modules` and `node_modules/newspack-scripts/node_modules`. See https://github.com/Automattic/newspack-scripts/issues/1 for more information._
+
+---
+
+## Misc
+
+### `@wordpress/*` packages
+
+This project list [`@wordpress/*` packages](https://github.com/WordPress/gutenberg/tree/trunk/packages) as dependencies in order to provide them to consumers. In a project using `calypso-build` (e.g. a consumer of `newspack-scripts`), the `@wordpress/*` packages are sourced from WP Core, not `node_modules`. The packages should be included in `node_modules`, though, to be available in other environments – notably when running tests. See [Dependency Extraction Webpack Plugin](https://www.npmjs.com/package/@wordpress/dependency-extraction-webpack-plugin) for more information.

package/bin/newspack-scripts.js

@@ -5,7 +5,7 @@ const spawn = require("cross-spawn");
 const [scriptName, ...nodeArgs] = process.argv.slice(2);
 
 if (
-  ["test", "build", "start", "commit", "commitlint", "release"].includes(
+  ["test", "build", "watch", "commit", "commitlint", "release"].includes(
     scriptName
   )
 ) {

package/config/eslintrc.js

@@ -1,3 +1,14 @@
+const path = require("path");
+
+// Assume `@wordpress/*` packages are available. This is because `calypso-build` is using
+// Dependency Extraction Webpack Plugin to use core WP packages instead of those from
+// node_modules. The packages should still be part of the project (so they are listed in this
+// project's package.json) so that they are available in testing environment.
+// More on this:
+// - https://www.npmjs.com/package/@wordpress/dependency-extraction-webpack-plugin
+// - https://github.com/WordPress/gutenberg/issues/35630
+const GLOBALLY_AVAILABLE_PACKAGES = ["@wordpress/.*"];
+
 module.exports = {
   extends: [
     "plugin:@wordpress/eslint-plugin/recommended",
@@ -16,7 +27,11 @@ module.exports = {
     camelcase: "off",
     // Disallow importing or requiring packages that are not listed in package.json
     // This prevents us from depending on transitive dependencies, which could break in unexpected ways.
-    "import/no-extraneous-dependencies": ["error", { packageDir: "." }],
+    "import/no-extraneous-dependencies": [
+      "error",
+      { packageDir: [".", path.resolve(__dirname, "../")] },
+    ],
+    "import/no-unresolved": ["error", { ignore: GLOBALLY_AVAILABLE_PACKAGES }],
     // There's a conflict with prettier here:
     "react/jsx-curly-spacing": "off",
     // Skip prop types validation for now

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newspack-scripts",
-  "version": "1.7.0-alpha.2",
+  "version": "2.0.0",
   "description": "",
   "bin": {
     "newspack-scripts": "./bin/newspack-scripts.js"