feat: repurpose as open edx footer (#46)

* feat: simplify prop api and bake in many values

* feat: refactor build and dev server

BREAKING CHANGE: The footer is now  transpiled from es6 preserving modules. To use this package in a project it must now be transpiled by the requiring project via webpack or other configuration

* feat: make this the open edx footer

BREAKING CHANGE: This footer now serves as the Open edX footer. For the edX footer see edx/frontend-component-footer-edx on github

.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 coverage
 dist
 node_modules

.travis.yml

@@ -1,19 +1,14 @@
 language: node_js
-node_js:
-  - 8
-cache:
-  directories:
-    - "~/.npm"
+node_js: 12
 install:
   - npm install
 script:
   - npm run lint
   - npm run i18n_extract
   - npm run test
   - npm run build
-  - npm run is-es5
 after_success:
-  - npm run travis-deploy-once "npm run semantic-release"
+  - npx semantic-release
   - npm run coveralls
 env:
   global:

Makefile

@@ -10,6 +10,14 @@ tx_url2 = https://www.transifex.com/api/2/project/edx-platform/resource/$(transi
 # This directory must match .babelrc .
 transifex_temp = ./temp/babel-plugin-react-intl
 
+build:
+	rm -rf ./dist
+	./node_modules/.bin/fedx-scripts babel src --out-dir dist --source-maps --ignore **/*.test.jsx,**/__mocks__,**/__snapshots__,**/setupTest.js --copy-files
+	@# --copy-files will bring in everything else that wasn't processed by babel. Remove what we don't want.
+	@rm -rf dist/**/*.test.jsx
+	@rm -rf dist/**/__snapshots__
+	@rm -rf dist/__mocks__
+
 requirements:
 	npm install
 

README.rst

@@ -5,9 +5,7 @@ frontend-component-footer
 |semantic-release|
 
 frontend-component-footer is a library containing a site footer
-component for use when building edX frontend applications.
-
-At this time, this component is hard-coded to match the legacy LMS site footer, including all of its links. As implemented, this component should probably be called the ``frontend-component-lms-footer``.
+component for use when building Open edX frontend applications.
 
 Usage
 -----
@@ -16,9 +14,30 @@ To install frontend-component-footer into your project::
 
    npm i --save @edx/frontend-component-footer
 
-The component expects properties specifying the various URLs that are
-linked in the footer. See the sample app in `src/index.jsx <src/index.jsx>`__ for an example
-of how the SiteFooter component can be specified.
+Component Usage::
+
+   import Footer from '@edx/frontend-component-footer';
+   import footerMessages from '@edx/frontend-component-footer/src/i18n/index';
+
+   ...
+
+   <Footer
+      handleAllTrackEvents={(eventName, properties) => {/* track click event */}}
+      onLanguageSelected={(languageCode) => {/* set language */}}
+      supportedLanguages={[
+         { label: 'English', value: 'en'},
+         { label: 'Español', value: 'es' },
+      ]}
+   />
+
+- handleAllTrackEvents (required)
+- onLanguageSelected (optional)
+- supportedLanguages (optional)
+
+Styles (project.scss)::
+
+   @import '@edx/frontend-component-footer/src/footer.scss';
+
 
 Requirements
 ------------

babel.config.js

@@ -0,0 +1,35 @@
+// These preset packages are included by frontend-build.
+// TODO: Add to frontend-build and leverage that config.
+module.exports = {
+  presets: [
+    [
+      '@babel/preset-env',
+      {
+        modules: false,
+      },
+    ],
+    '@babel/preset-react',
+  ],
+  plugins: [
+    '@babel/plugin-proposal-object-rest-spread',
+    '@babel/plugin-proposal-class-properties',
+  ],
+  env: {
+    i18n: {
+      plugins: [
+        [
+          'react-intl',
+          {
+            messagesDir: './temp/babel-plugin-react-intl',
+            moduleSourceName: '@edx/frontend-i18n',
+          },
+        ],
+      ],
+    },
+    test: {
+      presets: [
+        '@babel/preset-env',
+      ],
+    },
+  },
+};