@britannica/quiz-components - npm Package Compare versions

Comparing version 1.0.0-beta.1 to 1.0.0-beta.2

dist/common/types.d.ts

 export declare type QuizTemplateType = 'MultipleChoice';

dist/components/MultipleChoiceTemplate/MultipleChoiceTemplate.d.ts

@@ -1,3 +0,3 @@
-import { FC } from 'react';
+import type { FC } from 'react';
 declare const MultipleChoiceTemplate: FC;
 export default MultipleChoiceTemplate;

dist/components/MultipleChoiceTemplate/MultipleChoiceTemplate.stories.d.ts

@@ -1,4 +0,4 @@
-import { Meta } from '@storybook/react';
+import { Meta, Story } from '@storybook/react';
 declare const meta: Meta;
 export default meta;
-export declare const Default: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react").ReactFramework, import("@storybook/react").Args>;
+export declare const Default: Story<import("@storybook/react").Args>;

dist/components/Quiz/Quiz.d.ts

@@ -8,5 +8,5 @@ import { FC } from 'react';
     template: QuizTemplateType;
-    theme?: QuizTheme;
+    theme?: Partial<QuizTheme>;
 }
 declare const Quiz: FC<QuizProps>;
 export default Quiz;

dist/components/Quiz/Quiz.stories.d.ts

@@ -1,5 +0,5 @@
-import { Meta } from '@storybook/react';
+import { Meta, Story } from '@storybook/react';
 import { QuizProps } from './Quiz';
 declare const meta: Meta;
 export default meta;
-export declare const Default: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react").ReactFramework, QuizProps>;
+export declare const Default: Story<QuizProps>;

dist/components/TemplateLoader/TemplateLoader.d.ts

 import { FC } from 'react';
-import { QuizTemplateType } from '../../common/types';
+import type { QuizTemplateType } from '../../common/types';
 export interface TemplateLoaderProps {
@@ -4,0 +4,0 @@ template: QuizTemplateType;

dist/contexts/QuizDataContext/QuizDataContext.d.ts

@@ -0,0 +0,0 @@ /// <reference types="react" />

dist/contexts/ThemeContext/ThemeContext.d.ts

 /// <reference types="react" />
 export interface QuizTheme {
-    quizContainer?: string;
-    templateContainer?: string;
+    quizContainer: string;
 }
@@ -6,0 +5,0 @@ export declare const defaultTheme: QuizTheme;

dist/index.d.ts

 export { default as Quiz, QuizProps } from './components/Quiz/Quiz';

package.json

 {
   "name": "@britannica/quiz-components",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.2",
   "author": "Ryan Walters",
   "license": "MIT",
-  "module": "dist/quiz.esm.js",
-  "main": "dist/index.js",
+  "module": "dist/quiz-components.esm.production.js",
+  "main": "dist/quiz-components.cjs.production.js",
   "typings": "dist/index.d.ts",
-  "style": "dist/quiz.css",
+  "style": "dist/quiz-components.css",
   "files": [
@@ -14,11 +14,7 @@ "dist",
   ],
-  "engines": {
-    "node": ">=10"
-  },
   "scripts": {
-    "start": "tsdx watch",
-    "build": "tsdx build",
-    "test": "tsdx test --passWithNoTests",
-    "lint": "tsdx lint",
-    "prepare": "npm run build && husky install",
+    "start": "rollup -c -w",
+    "build": "rollup -c",
+    "test": "jest --passWithNoTests --silent",
+    "prepare": "husky install",
     "size": "size-limit",
@@ -39,7 +35,7 @@ "analyze": "size-limit --why",
     {
-      "path": "dist/quiz.cjs.production.min.js",
+      "path": "dist/quiz-components.cjs.production.js",
       "limit": "10 KB"
     },
     {
-      "path": "dist/quiz.esm.js",
+      "path": "dist/quiz-components.esm.production.js",
       "limit": "10 KB"
@@ -73,2 +69,9 @@ }
   },
+  "jest": {
+    "preset": "ts-jest",
+    "moduleNameMapper": {
+      "^.+\\.module\\.(scss)$": "identity-obj-proxy"
+    },
+    "testEnvironment": "jsdom"
+  },
   "devDependencies": {
@@ -78,6 +81,13 @@ "@babel/core": "^7.16.7",
     "@commitlint/config-conventional": "^16.0.0",
+    "@material-ui/core": "^4.12.3",
+    "@material-ui/icons": "^4.11.2",
+    "@rollup/plugin-babel": "^5.3.0",
+    "@rollup/plugin-commonjs": "^21.0.1",
+    "@rollup/plugin-node-resolve": "^13.1.3",
+    "@rollup/plugin-replace": "^3.1.0",
+    "@rollup/plugin-typescript": "^8.3.0",
     "@semantic-release/commit-analyzer": "^9.0.2",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^8.0.2",
-    "@semantic-release/npm": "^8.0.3",
+    "@semantic-release/npm": "^9.0.0",
     "@semantic-release/release-notes-generator": "^10.0.3",
@@ -92,8 +102,14 @@ "@size-limit/preset-small-lib": "^7.0.5",
     "@testing-library/react": "^12.1.2",
+    "@types/gtag.js": "^0.0.8",
     "@types/react": "^17.0.38",
     "@types/react-dom": "^17.0.11",
     "babel-loader": "^8.2.3",
+    "babel-plugin-annotate-pure-calls": "^0.4.0",
+    "babel-plugin-dev-expression": "^0.2.3",
     "html-webpack-plugin": "^5.5.0",
     "husky": "^7.0.0",
+    "identity-obj-proxy": "^3.0.0",
+    "jest": "^27.5.1",
     "postcss": "^8.4.5",
+    "prettier": "^2.5.1",
     "pretty-quick": "^3.1.3",
@@ -103,8 +119,11 @@ "react": "^17.0.2",
     "react-is": "^17.0.2",
+    "rollup": "^2.67.3",
     "rollup-plugin-postcss": "^4.0.2",
+    "rollup-plugin-sourcemaps": "^0.6.3",
+    "rollup-plugin-terser": "^7.0.2",
     "sass": "^1.48.0",
     "sass-loader": "^10.2.1",
-    "semantic-release": "^18.0.1",
+    "semantic-release": "^19.0.2",
     "size-limit": "^7.0.5",
-    "tsdx": "^0.14.1",
+    "ts-jest": "^27.1.3",
     "tslib": "^2.3.1",
@@ -114,4 +133,6 @@ "typescript": "^4.5.4"
   "dependencies": {
-    "deepmerge": "^4.2.2"
+    "classnames": "^2.3.1",
+    "deepmerge": "^4.2.2",
+    "tiny-warning": "^1.0.3"
   }
 }

README.md

@@ -1,181 +0,45 @@
-# TSDX React w/ Storybook User Guide
+# @britannica/quiz-components
 
-Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.
+> React component library for Britannica and Merriam-Webster quizzes
 
-> This TSDX setup is meant for developing React component libraries (not apps!) that can be published to NPM. If you’re looking to build a React-based app, you should use `create-react-app`, `razzle`, `nextjs`, `gatsby`, or `react-static`.
+## Using the library
 
-> If you’re new to TypeScript and React, checkout [this handy cheatsheet](https://github.com/sw-yx/react-typescript-cheatsheet/)
+Description coming soon.
 
-## Commands
+## Contributing
 
-TSDX scaffolds your new library inside `/src`, and also sets up a [Parcel-based](https://parceljs.org) playground for it inside `/example`.
+There are a few useful commands to know while developing.
 
-The recommended workflow is to run TSDX in one terminal:
+To get up and running:
 
 ```bash
-npm start # or yarn start
+npm install
 ```
 
-This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
+For local Storybook development:
 
-Then run either Storybook or the example playground:
-
-### Storybook
-
-Run inside another terminal:
-
 ```bash
-yarn storybook
+npm run storybook
 ```
 
-This loads the stories from `./stories`.
+To run tests:
 
-> NOTE: Stories should reference the components as if using the library, similar to the example playground. This means importing from the root project directory. This has been aliased in the tsconfig and the storybook webpack config as a helper.
-
-### Example
-
-Then run the example inside another:
-
 ```bash
-cd example
-npm i # or yarn to install dependencies
-npm start # or yarn start
+npm test
 ```
 
-The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. **No symlinking required**, we use [Parcel's aliasing](https://parceljs.org/module_resolution.html#aliases).
+To build a development version of the lib:
 
-To do a one-off build, use `npm run build` or `yarn build`.
-
-To run tests, use `npm test` or `yarn test`.
-
-## Configuration
-
-Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
-
-### Jest
-
-Jest tests are set up to run with `npm test` or `yarn test`.
-
-### Bundle analysis
-
-Calculates the real cost of your library using [size-limit](https://github.com/ai/size-limit) with `npm run size` and visulize it with `npm run analyze`.
-
-#### Setup Files
-
-This is the folder structure we set up for you:
-
-```txt
-/example
-  index.html
-  index.tsx       # test your component here in a demo app
-  package.json
-  tsconfig.json
-/src
-  index.tsx       # EDIT THIS
-/test
-  blah.test.tsx   # EDIT THIS
-/stories
-  Thing.stories.tsx # EDIT THIS
-/.storybook
-  main.js
-  preview.js
-.gitignore
-package.json
-README.md         # EDIT THIS
-tsconfig.json
-```
-
-#### React Testing Library
-
-We do not set up `react-testing-library` for you yet, we welcome contributions and documentation on this.
-
-### Rollup
-
-TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
-
-### TypeScript
-
-`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.
-
-## Continuous Integration
-
-### GitHub Actions
-
-Two actions are added by default:
-
-- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
-- `size` which comments cost comparison of your library on every pull request using [size-limit](https://github.com/ai/size-limit)
-
-## Optimizations
-
-Please see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations:
-
-```js
-// ./types/index.d.ts
-declare var __DEV__: boolean;
-
-// inside your code...
-if (__DEV__) {
-  console.log('foo');
-}
-```
-
-You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.
-
-## Module Formats
-
-CJS, ESModules, and UMD module formats are supported.
-
-The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.
-
-## Deploying the Example Playground
-
-The Playground is just a simple [Parcel](https://parceljs.org) app, you can deploy it anywhere you would normally deploy that. Here are some guidelines for **manually** deploying with the Netlify CLI (`npm i -g netlify-cli`):
-
 ```bash
-cd example # if not already in the example folder
-npm run build # builds to dist
-netlify deploy # deploy the dist folder
+npm run build
 ```
 
-Alternatively, if you already have a git repo connected, you can set up continuous deployment with Netlify:
+To build a production version of the lib:
 
 ```bash
-netlify init
-# build command: yarn build && cd example && yarn && yarn build
-# directory to deploy: example/dist
-# pick yes for netlify.toml
+npm run build -- --environment BUILD:production
 ```
 
-## Named Exports
+### Publishing to NPM
 
-Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.
-
-## Including Styles
-
-There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.
-
-For vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader.
-
-## Publishing to NPM
-
-We recommend using [np](https://github.com/sindresorhus/np).
-
-## Usage with Lerna
-
-When creating a new package with TSDX within a project set up with Lerna, you might encounter a `Cannot resolve dependency` error when trying to run the `example` project. To fix that you will need to make changes to the `package.json` file _inside the `example` directory_.
-
-The problem is that due to the nature of how dependencies are installed in Lerna projects, the aliases in the example project's `package.json` might not point to the right place, as those dependencies might have been installed in the root of your Lerna project.
-
-Change the `alias` to point to where those packages are actually installed. This depends on the directory structure of your Lerna project, so the actual path might be different from the diff below.
-
-```diff
-   "alias": {
--    "react": "../node_modules/react",
--    "react-dom": "../node_modules/react-dom"
-+    "react": "../../../node_modules/react",
-+    "react-dom": "../../../node_modules/react-dom"
-   },
-```
-
-An alternative to fixing this problem would be to remove aliases altogether and define the dependencies referenced as aliases as dev dependencies instead. [However, that might cause other problems.](https://github.com/palmerhq/tsdx/issues/64)
+Description coming soon.

src/declare.d.ts

@@ -5,1 +5,3 @@ declare module '*.scss' {
 }
+
+declare const __DEV__: boolean;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

93808

increased by156.1%

Number of package files

54

increased by58.82%

Lines of code

569

increased by84.74%

Number of low supply chain risk alerts

1

decreased by-50%

Worsened metrics

Dependency count

4

increased by100%

Dev dependency count

50

increased by47.06%

Number of low quality alerts

4

increased by33.33%

Number of lines in readme file

46

decreased by-74.73%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedclassnames@^2.3.1

• + Addedtiny-warning@^1.0.3

• + Addedclassnames@2.5.1(transitive)

• + Addedtiny-warning@1.0.3(transitive)