0.6.3 • Published 3 years ago

@misk/common v0.6.3

Weekly downloads
3,338
License
SEE LICENSE IN ht...
Repository
github
Last release
3 years ago

Misk Common

npm.io This package provides shared libraries, externals, and styles across Misk tab repos.

Getting Started

$ yarn add @misk/common

Automatic Inclusion

  • If your Webpack config builds off of a template in @misk/dev, vendors.js and styles.js will automatically be included in the build of that repo.
  • If your Webpack config does not build off of a template in @misk/dev, use the Manual Inclusion steps below.

Manual Inclusion

  • 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.css, vendors.js, and common.js

      <body>
        <!-- Misk Common Libraries -->
        <link rel="stylesheet" type="text/css" href="/@misk/common/styles.css" />
        <script type="text/javascript" src="/@misk/common/vendors.js" preload />
        <script type="text/javascript" src="/@misk/common/common.js" preload />
      
        <!-- Other JS -->
      </body>

Included Libraries

From package.json:

  @blueprintjs/core
  @blueprintjs/icons
  axios
  connected-react-router
  dayjs
  history
  immutable
  react
  react-dom
  react-helmet
  react-hot-loader
  react-redux
  react-router
  react-router-dom
  react-router-redux
  react-transition-group
  redux
  redux-saga
  skeleton-css
  styled-components

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 vendorExternals in @misk/dev/externals.js
  • Add window to javascript require include in src/vendors.js
  • Update README.md with a copy of the updated package.json list of packages

#Adding a Cached Remote Asset

  • There are sometimes cases where remote assets should be cached in order to be included in the single line imports of vendors.js or styles.js
  • Add a new task to package.json under the metadata key "miskCachedUrls" with the format as follows
    "miskCachedUrls": {
      "taskname": {
        "filepath": "font.css",
        "url": "https://url.com/fonts/font.css"
      },
      "taskname2": {...}
    }
    • taskname: string description of the remote asset
    • filepath: filepath within @misk/common/cachedUrls/ to which the url will be downloaded
    • url: valid url that within a browser downloads or presents the desired file
  • yarn run refresh initiates the download of all declared "miskCachedUrls" using code in ./refreshCachedUrls.js
  • Cached files are refreshed on every package publish to NPM

Webpack Configs

  • webpack.config.js: Exports common variables and functions
  • webpack.static.config.js: Exports common styles file
  • webpack.vendor.config.js: Exports common vendors library file

Releasing

Changelog (and Breaking Changes)

0.5.0

3 years ago

0.5.1

3 years ago

0.6.3

3 years ago

0.6.2

3 years ago

0.6.1

3 years ago

0.6.0

3 years ago

0.4.1

3 years ago

0.4.0

3 years ago

0.3.2

4 years ago

0.3.1

4 years ago

0.3.3

4 years ago

0.3.0

4 years ago

0.2.0-19

4 years ago

0.2.0-18

4 years ago

0.2.0-17

4 years ago

0.2.0-16

4 years ago

0.2.0-15

4 years ago

0.2.0-14

4 years ago

0.1.28-53

4 years ago

0.1.28-54

4 years ago

0.1.28-51

4 years ago

0.1.28-52

4 years ago

0.1.28-57

4 years ago

0.1.28-58

4 years ago

0.1.28-55

4 years ago

0.1.28-56

4 years ago

0.1.28-59

4 years ago

0.1.28-64

4 years ago

0.1.28-62

4 years ago

0.1.28-63

4 years ago

0.1.28-60

4 years ago

0.1.28-61

4 years ago

0.2.0-13

4 years ago

0.1.28-50

4 years ago

0.1.28-49

4 years ago

0.1.28-43

4 years ago

0.1.28-46

4 years ago

0.1.28-47

4 years ago

0.1.28-44

4 years ago

0.1.28-45

4 years ago

0.1.28-48

4 years ago

0.1.28-42

4 years ago

0.1.28-41

4 years ago

0.1.28-40

4 years ago

0.1.28-39

4 years ago

0.1.28-38

4 years ago

0.1.28-37

4 years ago

0.1.28-36

4 years ago

0.1.28-35

4 years ago

0.1.28-34

4 years ago

0.1.28-33

4 years ago

0.1.28-31

4 years ago

0.1.28-32

4 years ago

0.1.28-30

4 years ago

0.1.28-28

4 years ago

0.1.28-29

4 years ago

0.1.28-27

4 years ago

0.1.28-25

4 years ago

0.1.28-26

4 years ago

0.1.28-24

4 years ago

0.1.28-23

4 years ago

0.1.28-22

4 years ago

0.1.28-21

4 years ago

0.1.28-19

4 years ago

0.1.28-20

4 years ago

0.1.28-18

4 years ago

0.1.28-17

4 years ago

0.1.28-16

4 years ago

0.1.28-14

4 years ago

0.1.28-15

4 years ago

0.1.28-13

4 years ago

0.1.28-12

4 years ago

0.1.28-11

4 years ago

0.1.28-10

4 years ago

0.1.28-9

4 years ago

0.1.28-8

4 years ago

0.1.28-7

4 years ago

0.1.28-6

4 years ago

0.1.28-5

4 years ago

0.1.28-4

4 years ago

0.1.28-2

4 years ago

0.2.0-11

4 years ago

0.2.0-10

4 years ago

0.2.0-12

4 years ago

0.2.0-9

4 years ago

0.2.0-8

4 years ago

0.1.28-3

4 years ago

0.2.0-7

4 years ago

0.2.0-6

4 years ago

0.2.0-4

4 years ago

0.2.0-3

4 years ago

0.2.0-2

4 years ago

0.2.0-1

4 years ago

0.1.28-1

4 years ago

0.1.28-0

4 years ago

0.1.27

4 years ago

0.1.27-97

4 years ago

0.1.27-96

4 years ago

0.1.27-95

4 years ago

0.1.27-94

4 years ago

0.1.27-93

4 years ago

0.1.27-92

4 years ago

0.1.27-91

4 years ago

0.1.27-90

4 years ago

0.1.27-89

4 years ago

0.1.27-88

4 years ago

0.1.27-87

4 years ago

0.1.27-85

4 years ago

0.1.27-86

4 years ago

0.1.27-84

4 years ago

0.1.27-83

4 years ago

0.1.27-82

4 years ago

0.1.27-81

4 years ago

0.1.27-80

4 years ago

0.1.27-79

4 years ago

0.1.27-78

4 years ago

0.1.27-77

4 years ago

0.1.27-76

5 years ago

0.1.27-75

5 years ago

0.1.27-74

5 years ago

0.1.27-73

5 years ago

0.1.27-72

5 years ago

0.1.27-71

5 years ago

0.1.27-70

5 years ago

0.1.27-69

5 years ago

0.1.27-68

5 years ago

0.1.27-67

5 years ago

0.1.27-66

5 years ago

0.1.27-65

5 years ago

0.1.27-64

5 years ago

0.1.27-63

5 years ago

0.1.27-62

5 years ago

0.1.27-61

5 years ago

0.1.27-60

5 years ago

0.1.27-59

5 years ago

0.1.27-58

5 years ago

0.1.27-57

5 years ago

0.1.27-56

5 years ago

0.1.27-55

5 years ago

0.1.27-53

5 years ago

0.1.27-54

5 years ago

0.1.27-52

5 years ago

0.1.27-51

5 years ago

0.1.27-50

5 years ago

0.1.27-49

5 years ago

0.1.27-48

5 years ago

0.1.27-47

5 years ago

0.1.27-46

5 years ago

0.1.27-45

5 years ago

0.1.27-44

5 years ago

0.1.27-43

5 years ago

0.1.27-42

5 years ago

0.1.27-41

5 years ago

0.1.27-40

5 years ago

0.1.27-39

5 years ago

0.1.27-38

5 years ago

0.1.27-37

5 years ago

0.1.27-36

5 years ago

0.1.27-35

5 years ago

0.1.27-34

5 years ago

0.1.27-32

5 years ago

0.1.27-33

5 years ago

0.1.27-30

5 years ago

0.1.27-31

5 years ago

0.1.27-29

5 years ago

0.1.27-28

5 years ago

0.1.27-27

5 years ago

0.1.27-26

5 years ago

0.1.27-25

5 years ago

0.1.27-24

5 years ago

0.1.27-23

5 years ago

0.1.27-22

5 years ago

0.1.27-21

5 years ago

0.1.27-20

5 years ago

0.1.27-16

5 years ago

0.1.27-17

5 years ago

0.1.27-18

5 years ago

0.1.27-19

5 years ago

0.1.27-14

5 years ago

0.1.27-15

5 years ago

0.1.27-13

5 years ago

0.1.27-12

5 years ago

0.1.27-11

5 years ago

0.1.27-10

5 years ago

0.1.27-9

5 years ago

0.1.27-8

5 years ago

0.1.27-7

5 years ago

0.1.27-6

5 years ago

0.1.27-5

5 years ago

0.1.27-4

5 years ago

0.1.27-3

5 years ago

0.1.27-2

5 years ago

0.1.27-1

5 years ago

0.1.27-0

5 years ago

0.1.26-91

5 years ago

0.1.26

5 years ago

0.1.26-90

5 years ago

0.1.26-89

5 years ago

0.1.26-88

5 years ago

0.1.26-87

5 years ago

0.1.26-86

5 years ago

0.1.26-85

5 years ago

0.1.26-84

5 years ago

0.1.26-83

5 years ago

0.1.26-82

5 years ago

0.1.26-81

5 years ago

0.1.26-80

5 years ago

0.1.26-79

5 years ago

0.1.26-78

5 years ago

0.1.26-77

5 years ago

0.1.26-76

5 years ago

0.1.26-75

5 years ago

0.1.26-74

5 years ago

0.1.26-73

5 years ago

0.1.26-72

5 years ago

0.1.26-71

5 years ago

0.1.26-70

5 years ago

0.1.26-69

5 years ago

0.1.26-68

5 years ago

0.1.26-67

5 years ago

0.1.26-66

5 years ago

0.1.26-65

5 years ago

0.1.26-64

5 years ago

0.1.26-63

5 years ago

0.1.26-62

5 years ago

0.1.26-61

5 years ago

0.1.26-60

5 years ago

0.1.26-59

5 years ago

0.1.26-58

5 years ago

0.1.26-57

5 years ago

0.1.26-56

5 years ago

0.1.26-55

5 years ago

0.1.26-54

5 years ago

0.1.26-53

5 years ago

0.1.26-52

5 years ago

0.1.26-51

5 years ago

0.1.26-50

5 years ago

0.1.26-49

5 years ago

0.1.26-48

5 years ago

0.1.26-47

5 years ago

0.1.26-46

5 years ago

0.1.26-45

5 years ago

0.1.26-44

5 years ago

0.1.26-43

5 years ago

0.1.26-42

5 years ago

0.1.26-41

5 years ago

0.1.26-40

5 years ago

0.1.26-39

5 years ago

0.1.26-38

5 years ago

0.1.26-37

5 years ago

0.1.26-36

5 years ago

0.1.26-35

5 years ago

0.1.26-34

5 years ago

0.1.26-33

5 years ago

0.1.26-32

5 years ago

0.1.26-31

5 years ago

0.1.26-30

5 years ago

0.1.26-29

5 years ago

0.1.26-28

5 years ago

0.1.26-27

5 years ago

0.1.26-26

5 years ago

0.1.26-25

5 years ago

0.1.26-24

5 years ago

0.1.26-23

5 years ago

0.1.26-22

5 years ago

0.1.26-21

5 years ago

0.1.26-19

5 years ago

0.1.26-20

5 years ago

0.1.26-18

5 years ago

0.1.26-17

5 years ago

0.1.26-16

5 years ago

0.1.26-15

5 years ago

0.1.26-14

5 years ago

0.1.26-13

5 years ago

0.1.26-12

5 years ago

0.1.26-11

5 years ago

0.1.26-10

5 years ago

0.1.26-9

5 years ago

0.1.26-8

5 years ago

0.1.26-7

5 years ago

0.1.26-6

5 years ago

0.1.26-5

5 years ago

0.1.26-4

5 years ago

0.1.26-3

5 years ago

0.1.26-1

5 years ago

0.1.26-0

5 years ago

0.1.26-2

5 years ago

0.1.25

5 years ago

0.1.24

5 years ago

0.1.23

6 years ago

0.1.23-4

6 years ago

0.1.23-3

6 years ago

0.1.23-2

6 years ago

0.1.23-1

6 years ago

0.1.23-0

6 years ago

0.1.22

6 years ago

0.1.21

6 years ago

0.1.20

6 years ago

0.1.20-4

6 years ago

0.1.20-3

6 years ago

0.1.20-2

6 years ago

0.1.20-1

6 years ago

0.1.20-0

6 years ago

0.1.19

6 years ago

0.1.19-3

6 years ago

0.1.19-2

6 years ago

0.1.19-1

6 years ago

0.1.19-0

6 years ago

0.1.18

6 years ago

0.1.18-7

6 years ago

0.1.18-6

6 years ago

0.1.18-5

6 years ago

0.1.18-4

6 years ago

0.1.18-3

6 years ago

0.1.18-2

6 years ago

0.1.18-1

6 years ago

0.1.18-0

6 years ago

0.1.17

6 years ago

0.1.17-4

6 years ago

0.1.17-3

6 years ago

0.1.17-2

6 years ago

0.1.17-1

6 years ago

0.1.17-0

6 years ago

0.1.16

6 years ago

0.1.16-4

6 years ago

0.1.16-3

6 years ago

0.1.16-2

6 years ago

0.1.16-1

6 years ago

0.1.16-0

6 years ago

0.1.15

6 years ago

0.1.14

6 years ago

0.1.13

6 years ago

0.1.13-1

6 years ago

0.1.13-0

6 years ago

0.1.12

6 years ago

0.1.11

6 years ago

0.1.10

6 years ago

0.1.9

6 years ago

0.1.8

6 years ago

0.1.7

6 years ago

0.1.6

6 years ago

0.1.5

6 years ago

0.1.5-43

6 years ago

0.1.5-42

6 years ago

0.1.5-41

6 years ago

0.1.5-40

6 years ago

0.1.5-39

6 years ago

0.1.5-38

6 years ago

0.1.5-37

6 years ago

0.1.5-36

6 years ago

0.1.5-35

6 years ago

0.1.5-34

6 years ago

0.1.5-33

6 years ago

0.1.5-32

6 years ago

0.1.5-31

6 years ago

0.1.5-30

6 years ago

0.1.5-29

6 years ago

0.1.5-28

6 years ago

0.1.5-27

6 years ago

0.1.5-26

6 years ago

0.1.5-25

6 years ago

0.1.5-24

6 years ago

0.1.5-23

6 years ago

0.1.5-22

6 years ago

0.1.5-21

6 years ago

0.1.5-20

6 years ago

0.1.5-19

6 years ago

0.1.5-18

6 years ago

0.1.5-17

6 years ago

0.1.5-16

6 years ago

0.1.5-15

6 years ago

0.1.5-14

6 years ago

0.1.5-13

6 years ago

0.1.5-12

6 years ago

0.1.5-11

6 years ago

0.1.5-10

6 years ago

0.1.5-9

6 years ago

0.1.5-8

6 years ago

0.1.5-7

6 years ago

0.1.5-6

6 years ago

0.1.5-5

6 years ago

0.1.5-4

6 years ago

0.1.5-3

6 years ago

0.1.5-2

6 years ago

0.1.5-1

6 years ago

0.1.4

6 years ago

0.1.4-14

6 years ago

0.1.4-13

6 years ago

0.1.4-12

6 years ago

0.1.4-11

6 years ago

0.1.4-10

6 years ago

0.1.4-9

6 years ago

0.1.4-8

6 years ago

0.1.4-6

6 years ago

0.1.4-3

6 years ago

0.1.4-2

6 years ago

0.1.4-1

6 years ago

0.1.3

6 years ago

0.1.3-19

6 years ago

0.1.3-18

6 years ago

0.1.3-16

6 years ago

0.1.3-15

6 years ago

0.1.3-14

6 years ago

0.1.3-13

6 years ago

0.1.3-12

6 years ago

0.1.3-11

6 years ago

0.1.3-10

6 years ago

0.1.3-9

6 years ago

0.1.3-8

6 years ago

0.1.3-7

6 years ago

0.1.3-6

6 years ago

0.1.3-5

6 years ago

0.1.3-4

6 years ago

0.1.3-3

6 years ago

0.1.3-2

6 years ago

0.1.3-1

6 years ago

0.1.1

7 years ago

0.1.1-alpha-0.3

7 years ago

0.1.1-alpha-0.2

7 years ago

0.1.1-alpha-0.1

7 years ago

0.1.0

7 years ago

0.1.0-alpha-0.10

7 years ago

0.1.0-alpha-0.9

7 years ago

0.1.0-alpha-0.8

7 years ago

0.1.0-alpha-0.7

7 years ago

0.1.0-alpha-0.6

7 years ago

0.1.0-alpha-0.5

7 years ago

0.1.0-alpha-0.4

7 years ago

0.1.0-alpha-0.3

7 years ago

0.1.0-alpha-0.2

7 years ago

0.1.0-alpha-0.1

7 years ago

0.0.70

7 years ago

0.0.68

7 years ago

0.0.67

7 years ago

0.0.66

7 years ago

0.0.65

7 years ago

0.0.64

7 years ago

0.0.63

7 years ago

0.0.62

7 years ago

0.0.61

7 years ago

0.0.60

7 years ago

0.0.59

7 years ago

0.0.58

7 years ago

0.0.57

7 years ago

0.0.56

7 years ago

0.0.55

7 years ago

0.0.54

7 years ago

0.0.53

7 years ago

0.0.52

7 years ago

0.0.51

7 years ago

0.0.50

7 years ago

0.0.49

7 years ago

0.0.48

7 years ago

0.0.47

7 years ago

0.0.46

7 years ago

0.0.45

7 years ago

0.0.44

7 years ago

0.0.43

7 years ago

0.0.42

7 years ago

0.0.41

7 years ago

0.0.40

7 years ago

0.0.39

7 years ago

0.0.38

7 years ago

0.0.36

7 years ago

0.0.35

7 years ago

0.0.34

7 years ago

0.0.33

7 years ago

0.0.32

7 years ago

0.0.31

7 years ago

0.0.30

7 years ago

0.0.29

7 years ago

0.0.28

7 years ago

0.0.27

7 years ago

0.0.26

7 years ago

0.0.25

7 years ago

0.0.24

7 years ago

0.0.23

7 years ago

0.0.22

7 years ago

0.0.21

7 years ago

0.0.20

7 years ago

0.0.19

7 years ago

0.0.18

7 years ago

0.0.17

7 years ago

0.0.16

7 years ago

0.0.15

7 years ago

0.0.14

7 years ago

0.0.13

7 years ago

0.0.12

7 years ago

0.0.11

7 years ago

0.0.10

7 years ago

0.0.9

7 years ago

0.0.8

7 years ago

0.0.7

7 years ago

0.0.6

7 years ago

0.0.5

7 years ago

0.0.4

7 years ago

0.0.3

7 years ago

0.0.2

7 years ago