npmpackage.info

Gathering detailed insights and metrics for relay-compiler-webpack-plugin

Other packages similar to relay-compiler-webpack-plugin

@ch1ffa/relay-compiler-webpack-plugin

0.3.0

Webpack pluging for running relay-compiler in webpack dev mode

relay-compiler

18.2.0

A compiler tool for building GraphQL-driven applications.

@ngtools/webpack

19.0.2

Webpack plugin that AoT compiles your Angular components and modules.

relay-compiler-language-typescript

15.0.1

A language plugin for Relay that adds TypeScript support, including emitting type definitions.

Gathering detailed insights and metrics for relay-compiler-webpack-plugin

relay-compiler-webpack-plugin

Automatically run the Relay Compiler from Webpack

9.1.0

BSD-3-Clause

JavaScript

709,896 2.6

Installations

npm install relay-compiler-webpack-plugin

Pull Requests

Open

10

Total

55

Closed

6

Merged

39

Issues

Open

7

Total

24

Closed

17

Releases

v9.1.0

Published on 18 May 2021

v9.0.0

Published on 17 May 2021

v8.1.0

Published on 26 May 2020

v8.0.2

Published on 06 Jan 2020

v8.0.0

Published on 03 Jan 2020

v7.0.0

Published on 08 Nov 2019

View all 49 releases

Developer

danielholmes

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

NPM Version

Statistics

65 Stars

256 Commits

35 Forks

4 Watching

15 Branches

29 Contributors

Updated on 25 Aug 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

709,896

Last day

-6.2%

256

Compared to previous day

Last week

-8.3%

1,426

Compared to previous week

Last month

-28%

12,399

Compared to previous month

Last year

134.7%

136,049

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Relay Compiler Webpack Plugin

Are you running Relay Modern? Are you annoyed with constantly running the relay-compiler to generate code, especially if you're already running Webpack?

Well be annoyed no more! Simply install this plugin to automatically hook into Webpack's build process to generate these files for you.

Installation

Add this to your project:

1  yarn add --dev relay-compiler-webpack-plugin graphql
2  # Or if you're using npm
3  npm install --save-dev relay-compiler-webpack-plugin graphql

Add the plugin to your Webpack configuration:

1// const RelayCompilerLanguageTypescript = require('relay-compiler-language-typescript').default
2const RelayCompilerWebpackPlugin = require('relay-compiler-webpack-plugin')
3const path = require('path')
4
5module.exports = {
6  // ... Your existing Webpack configuration
7  plugins: [
8    // ...
9    new RelayCompilerWebpackPlugin({
10      // languagePlugin: RelayCompilerLanguageTypescript,
11      schema: path.resolve(__dirname, './relative/path/to/schema.graphql'), // or schema.json
12      src: path.resolve(__dirname, './relative/path/to/source/files'),
13    })
14  ]
15  // ...
16}

Note: TypeScript projects also needs to add the TypeScript language plugin as shown in the commented out lines in the above snippet.

:tada:

Gotchas

If there are multiple versions of GraphQL in your dependency tree it will cause schema validation errors. To get around this, ensure you have the same graphql version as your relay-compiler version depends on. To assist this you can install dependencies as flat which ensures only one version of each dependency.

Plugin hooks

relay-compiler-webpack-plugin exposes a few tapable hooks, for plugins or tooling to use.

beforeWrite called before the plugin starts to compile queries
afterWrite(compileResult): called after writing is complete

1class MyPlugin {
2  apply (compiler) {
3    compiler.hooks.compilation.tap('MyPlugin', async (compilation) => {
4      RelayCompilerWebpackPlugin.getHooks(compilation).afterWrite.tapPromise(
5        'MyPlugin', // <-- Set a meaningful name for stacktraces
6        async (compileResult) => {
7          if (compileResult === 'HAS_CHANGES') {
8            await doSomething()
9          }
10        }
11      )
12    })
13  }
14}

Example Project

To see an example of its usage within a project, see relay-compiler-webpack-plugin-example.

Development

Running tests:

1yarn test

Running tests with coverage:

1yarn test:coverage

License

Relay Compiler Webpack Plugin may be redistributed according to the BSD 3-Clause License.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

40 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

2.6

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to relay-compiler-webpack-plugin

Other packages similar to relay-compiler-webpack-plugin

relay-compiler-webpack-plugin

Installations

Pull Requests

10

55

6

39

Issues

7

24

17

Releases

Developer

danielholmes

Developer Guide

CommonJS

No

Statistics

Languages

Total Downloads

709,896

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

Relay Compiler Webpack Plugin

Installation

Gotchas

Plugin hooks

Example Project

Development

License

10

10

10

1

0

0

0

0

0

0

0

0

0

2.6

/10