Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

@misk/common

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@misk/common

Microservice Kontainer Common Libraries, Externals, Styles

0.0.12
Source
npm

Version published: 6 years ago

Maintainers: 2

Created: 6 years ago

Source

@misk/common

@misk/common provides shared libraries, externals, and styles between @misk modules.

Getting Started

Install @misk/common

$ yarn add @misk/common

Using the common vendors libraries and styles. We use copy-webpack-plugin to copy the compiled vendor.js and styles.js files into build folder.
- Install copy-webpack-plugin
```
npm i -D copy-webpack-plugin
```
- Add the following to your webpack.config.js
```
const CopyWebpackPlugin = require('copy-webpack-plugin');
...

module.exports = {
  mode
  entry
  ...
  plugins: [
    new CopyWebpackPlugin(
      [{ from: './node_modules/@misk/common/lib' }], 
      { debug: 'info', copyUnmodified: true }
    )
  ],
}
```
- Add the following to your index.html to import styles.js and vendors.js
```
<body>

  ...

  
  <script type="text/javascript" src="js/styles.js" async></script>
  <script type="text/javascript" src="js/vendors.js" preload></script>

  
</body>
```
Use @misk/common externals to keep Webpack from bundling duplicate libraries and styles into your Misk module. Add the following to your webpack.config.js.
```
const MiskCommon = require('@misk/common')

...

module.exports = {
  mode
  entry
  ...
  externals: MiskCommon.externals,
}
```

Included Libraries

From package.json:

  "@blueprintjs/core": "^3.0.1",
  "@blueprintjs/icons": "^3.0.0",
  "axios": "^0.18.0",
  "connected-react-router": "^4.3.0",
  "dayjs": "^1.7.4",
  "history": "^4.7.2",
  "immutable": "^3.8.2",
  "react": "^16.4.1",
  "react-dom": "^16.4.1",
  "react-helmet": "^5.2.0",
  "react-hot-loader": "^4.3.3",
  "react-redux": "^5.0.7",
  "react-router": "^4.3.1",
  "react-router-dom": "^4.3.1",
  "react-router-redux": "^5.0.0-alpha.9",
  "react-transition-group": "^2.2.1",
  "redux": "^4.0.0",
  "redux-saga": "^0.16.0"
  "skeleton-css": "^2.0.4",
  "styled-components": "^3.3.3"

Included Styles

  import '../node_modules/@blueprintjs/core/lib/css/blueprint.css'
  import '../node_modules/normalize.css/normalize.css'
  import '../node_modules/skeleton-css/css/skeleton.css'
  import './styles/misk-common.css'

Contributing

#Adding a new package

yarn add {package} to add the package to package.json
Add package to window variable mapping to src/externals.ts
Add window to javascript require include in src/vendors.js
Update README.md with a copy of the updated package.json list of packages

Webpack Configs

webpack.config.js: Exports common variables including MiskCommon.Externals
webpack.static.config.js: Exports common styles file
webpack.vendor.config.js: Exports common vendors library file
webpack.basetab.config.js: Base config used for each tab

Releasing

FAQs

What is @misk/common?

Is @misk/common well maintained?

Package last updated on 14 Aug 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@misk/common

@misk/common

Getting Started

Included Libraries

Included Styles

Contributing

Webpack Configs

Releasing

Related posts

Typosquatting Cryptographic Libraries: Malicious npm Packages Threaten Crypto Developers with Keylogging and Wallet Theft

Weekly Downloads Now Available in npm Package Search Results