@financial-times/n-myft-ui 23.1.3 → 24.0.0

package/.circleci/config.yml

@@ -2,7 +2,6 @@
 # template: component
 
 references:
-
   container_config_node12: &container_config_node12
     working_directory: ~/project/build
     docker:
@@ -13,8 +12,7 @@ references:
     docker:
       - image: lambci/lambda:build-nodejs12.x
 
-  workspace_root: &workspace_root
-    ~/project
+  workspace_root: &workspace_root ~/project
 
   attach_workspace: &attach_workspace
     attach_workspace:
@@ -22,31 +20,31 @@ references:
 
   npm_cache_keys: &npm_cache_keys
     keys:
-        - v3-dependency-npm-{{ checksum "package.json" }}-
-        - v3-dependency-npm-{{ checksum "package.json" }}
-        - v3-dependency-npm-
+      - v3-dependency-npm-{{ checksum "package.json" }}-
+      - v3-dependency-npm-{{ checksum "package.json" }}
+      - v3-dependency-npm-
 
   cache_npm_cache: &cache_npm_cache
     save_cache:
-        key: v3-dependency-npm-{{ checksum "package.json" }}-{{ epoch }}
-        paths:
+      key: v3-dependency-npm-{{ checksum "package.json" }}-{{ epoch }}
+      paths:
         - ./node_modules/
 
   restore_npm_cache: &restore_npm_cache
     restore_cache:
-        <<: *npm_cache_keys
+      <<: *npm_cache_keys
 
   filters_ignore_gh_pages: &filters_ignore_gh_pages
     branches:
       ignore: gh_pages
 
-  filters_only_master: &filters_only_master
+  filters_only_main: &filters_only_main
     branches:
-      only: master
+      only: main
 
-  filters_ignore_master: &filters_ignore_master
+  filters_ignore_main: &filters_ignore_main
     branches:
-      ignore: master
+      ignore: main
 
   filters_ignore_tags: &filters_ignore_tags
     tags:
@@ -62,7 +60,6 @@ references:
 version: 2
 
 jobs:
-
   build:
     <<: *container_config_node12
     steps:
@@ -149,7 +146,7 @@ workflows:
             - build
       - deploy:
           filters:
-            <<: *filters_only_master
+            <<: *filters_only_main
           requires:
             - build
   build-test-publish:
@@ -173,7 +170,7 @@ workflows:
       - schedule:
           cron: "0 0 * * *"
           filters:
-            <<: *filters_only_master
+            <<: *filters_only_main
     jobs:
       - build:
           context: next-nightly-build

package/.circleci/shared-helpers/helper-npm-install-peer-deps

@@ -11,10 +11,10 @@
 #
 # Why we pass the flags we do to `npm install`:
 #
-# --no-package-lock - While we now use package-lock.json 
-#   in our repos, skip package-lock.json in this instance 
-#   as we don't want to accidentally modify the file 
-#   for subsequent steps in the workflow, e.g cache keys 
+# --no-package-lock - While we now use package-lock.json
+#   in our repos, skip package-lock.json in this instance
+#   as we don't want to accidentally modify the file
+#   for subsequent steps in the workflow, e.g cache keys
 #   and artefact generation.
 #
 # --no-save - We don't want to modify package.json as we
@@ -34,6 +34,7 @@ if [ -e package.json ]; then
 
     npm ls --production --parseable 2>&1 >/dev/null | \
       sed -n -e 's/^npm ERR! peer dep missing: \(.*\),.*/\1/p' | \
-        xargs -I{} npm install --no-package-lock --no-save "{}"
+          xargs -I{} echo -n '"{}" ' | \
+            xargs npm install --no-package-lock --no-save
 
 fi

package/.github/settings.yml

@@ -1,7 +1,7 @@
 _extends: github-apps-config-next
 
 branches:
-  - name: master
+  - name: main
     protection:
       required_pull_request_reviews: null
       required_status_checks:

package/.scss-lint.yml

@@ -1,7 +1,6 @@
 linters:
-
   # Documentation:
-  # https://github.com/causes/scss-lint/blob/master/lib/scss_lint/linter/README.md
+  # https://github.com/causes/scss-lint/blob/HEAD/lib/scss_lint/linter/README.md
 
   # "value !important;" not "value!important ;"
   BangFormat:
@@ -262,7 +261,8 @@ linters:
     enabled: true
     identifier_list: base
     additional_identifiers: []
-    excluded_identifiers: ["user-select", "appearance", "font-smoothing", "osx-font-smoothing"]
+    excluded_identifiers:
+      ["user-select", "appearance", "font-smoothing", "osx-font-smoothing"]
     severity: warning
 
   # No units on zero values: 0 not 0px

package/Makefile

@@ -46,3 +46,4 @@ test:
 	make test-unit
 	make test-build
 	make a11y
+	jest

package/README.md

@@ -16,22 +16,25 @@ These subdirectories may contain a README. If not, please speak to the myft team
 n-myft-ui provides the CSS, JS and most templates for the myFT components on FT.com. We use semver to control rollout of the code.
 
 As of August 2017, The following apps use n-myft-ui:
-* next-front-page
-* next-stream-page
-* next-article
-* next-myft-page
-* next-tour-page
-* next-video-page
-* next-search-page
 
-When you merge to master, you should make a new release and then roll it out to the apps, plus n-topic-card which contains a reference to this so that there aren't missing dependencies.
+- next-front-page
+- next-stream-page
+- next-article
+- next-myft-page
+- next-tour-page
+- next-video-page
+- next-search-page
+
+When you merge to main, you should make a new release and then roll it out to the apps, plus n-topic-card which contains a reference to this so that there aren't missing dependencies.
 
 If you are making a major change, you will need to update the bower.json and package.json files for the above apps. For minor and patch updates, you can rebuild without cache from CircleCI.
 
 ## Running locally
+
 ```
 make install
 make build
 make demo
 ```
+
 View the demo on `localhost:5005`