Merge pull request #4 from customink/kp/update_deps

v0.5.0

.eslintrc.js

@@ -0,0 +1,21 @@
+module.exports = {
+  extends: ['eslint:recommended', 'prettier'],
+  env: {
+    browser: true,
+    'jest/globals': true,
+    node: true,
+    es6: true,
+    mocha: true
+  },
+  parser: '@babel/eslint-parser',
+  plugins: ['@babel', 'jest'],
+  parserOptions: {
+    ecmaVersion: 6,
+    ecmaFeatures: {
+      modules: true
+    }
+  },
+  globals: {
+    assert: false
+  }
+};

.node-version

@@ -0,0 +1 @@
+16.4.2

.prettierignore

@@ -0,0 +1,5 @@
+node_modules
+coverage
+npm-debug.log
+signalerjs.min.js
+package-lock.json

.prettierrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  arrowParens: 'avoid',
+  bracketSpacing: false,
+  jsxBracketSameLine: true,
+  printWidth: 80,
+  singleQuote: true,
+  trailingComma: 'none'
+};

.travis.yml

@@ -2,5 +2,5 @@ language: node_js
 script: npm run lint && npm test
 sudo: false
 node_js:
-  - "0.12"
-  - "4.0.0"
+  - '0.12'
+  - '4.0.0'

CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.5.0] - 2022-02-01
+
+### Added
+
+- A CHANGELOG! (a little meta but here we are)
+- Introduced [Jest](https://jestjs.io/) as the new testing framework
+- Added [Prettier](https://prettier.io/)
+
+### Changed
+
+- Updated the outdated Karma tests to Jest tests
+- Bumped Node, Babel, Webpack, & ESLint versions
+
+### Removed
+
+- All other testing libraries: karma, chai, sinon, phantomjs, mocha, istanbul

README.md

@@ -76,20 +76,20 @@ See full [API docs](docs/api.md).
 
 ```js
 // get feature flags user is opted into
-signal.featureFlags().then(function(flags) {
-// flags =>
-// {
-//   flagOne: 'test',
-//   flagTwo: 'control',
-//   anotherFlag: 'flagValue',
-//   // user has not yet been sampled into this test group
-//   yetAnother: undefined
-// }
+signal.featureFlags().then(function (flags) {
+  // flags =>
+  // {
+  //   flagOne: 'test',
+  //   flagTwo: 'control',
+  //   anotherFlag: 'flagValue',
+  //   // user has not yet been sampled into this test group
+  //   yetAnother: undefined
+  // }
 });
 
 // read flag value for given feature
-signal.featureFlag('flagOne').then(function(flag) {
-// flag => 'test'
+signal.featureFlag('flagOne').then(function (flag) {
+  // flag => 'test'
 });
 ```
 

babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [['@babel/preset-env', {targets: {node: 'current'}}]]
+};

docs/api.md

@@ -48,13 +48,13 @@ Returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
 ```js
 var signal = new Signaler(features);
 
-signal.featureFlags().then(function(flags) {
-// flags =>
-// {
-//   featureOne: 'test',
-//   featureTwo: 'control',
-//   featureS: undefined
-// }
+signal.featureFlags().then(function (flags) {
+  // flags =>
+  // {
+  //   featureOne: 'test',
+  //   featureTwo: 'control',
+  //   featureS: undefined
+  // }
 });
 ```
 
@@ -65,7 +65,7 @@ Returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe
 ```js
 var signal = new Signaler(features);
 
-signal.featureFlag('featureOne').then(function(flag) {
+signal.featureFlag('featureOne').then(function (flag) {
   // flag => 'test'
 });
 ```

docs/configuration.md

@@ -7,6 +7,7 @@ The `Signalerjs` function takes an optional configuration object as its second a
 The `cookieDefaults` key of the configuration object allows to set the default options used when setting cookies (`path`, `domain`, and `expires`).
 
 Defaults:
+
 - `path`: '/'
 - `domain`: `window.location.hostname`
 - `expires`: 30 days after the current date
@@ -29,7 +30,7 @@ This is a hook to allow for even more dynamic configuration of the cookie option
 ```js
 var primaryEndpoint = '/myUrl';
 var config = {
-  transformCookieOptions: function(config) {
+  transformCookieOptions: function (config) {
     return {
       path: config.path,
       expires: Math.floor(Math.random() * 30) + 1

jest.config.js

@@ -0,0 +1,194 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/5t/fr619zgs6d56b_thsv30ljk80000gn/T/jest_dx",
+
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: 'coverage',
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  // coverageProvider: "babel",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: 'jsdom'
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};