gatsby-plugin-rudderstack 1.1.1 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md ADDED
@@ -0,0 +1,14 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
4
+
5
+ ## 2.0.0 (2022-12-14)
6
+
7
+
8
+ ### ⚠ BREAKING CHANGES
9
+
10
+ * modify delayLoad functionality (#17)
11
+
12
+ ### Features
13
+
14
+ * modify delayLoad functionality ([#17](https://github.com/rudderlabs/gatsby-plugin-rudderstack/issues/17)) ([65f176d](https://github.com/rudderlabs/gatsby-plugin-rudderstack/commit/65f176dd8e7fff4749b7142ba16d63519651fe45))
package/README.md CHANGED
@@ -40,7 +40,7 @@ plugins: [
40
40
  // required; non-empty string
41
41
  //NOTE: Do not commit this to git. Process from env.
42
42
  prodKey: `RUDDERSTACK_PRODUCTION_WRITE_KEY`,
43
-
43
+
44
44
  // if you have a development env for your rudderstack account, paste that key here
45
45
  // when process.env.NODE_ENV === 'development'
46
46
  // optional; non-empty string
@@ -59,18 +59,19 @@ plugins: [
59
59
  // If you need to proxy events through a custom data plane,
60
60
  // add a `dataPlaneUrl` property (defaults to https://hosted.rudderlabs.com )
61
61
  // RudderStack docs:
62
- // - https://docs.rudderstack.com/rudderstack-sdk-integration-guides/rudderstack-javascript-sdk#3-1-load
62
+ // - https://rudderstack.com/docs/sources/event-streams/sdks/rudderstack-javascript-sdk/#31-load
63
63
  dataPlaneUrl: `https://override-rudderstack-endpoint`,
64
64
 
65
65
  // Add a `controlPlaneUrl` property if you are self-hosting the Control Plane
66
66
  // RudderStack docs:
67
- // - https://docs.rudderstack.com/rudderstack-sdk-integration-guides/rudderstack-javascript-sdk#3-1-1-self-hosted-control-plane
67
+ // - https://rudderstack.com/docs/sources/event-streams/sdks/rudderstack-javascript-sdk/#311-self-hosted-control-plane
68
68
  controlPlaneUrl: `https://override-control-plane-url`,
69
69
 
70
- // boolean (defaults to false); whether to delay load RudderStack
70
+ // boolean (defaults to false); whether to delay loading (add SDK script and load the SDK) of RudderStack JS SDK.
71
71
  // ADVANCED FEATURE: only use if you leverage client-side routing (ie, Gatsby <Link>)
72
72
  // This feature will force RudderStack to load _after_ either a page routing change
73
- // or user scroll, or after `delayLoadTime` elapses, whichever comes first. This feature is used to help improve your website's
73
+ // or user scroll, whichever comes first. This delay time is controlled by
74
+ // `delayLoadTime` setting. This feature is used to help improve your website's
74
75
  // TTI (for SEO, UX, etc). See links below for more info.
75
76
  // NOTE: But if you are using server-side routing and enable this feature,
76
77
  // RudderStack will never load (because although client-side routing does not do
@@ -82,8 +83,7 @@ plugins: [
82
83
  // Problem/solution: https://marketingexamples.com/seo/performance
83
84
  delayLoad: false,
84
85
 
85
- // number (default to 1000); time to wait after the page loads
86
- // to load the RudderStack SDK
86
+ // number (default to 1000); time to wait after scroll or route change
87
87
  // To be used when `delayLoad` is set to `true`
88
88
  delayLoadTime: 1000,
89
89
 
@@ -95,6 +95,11 @@ plugins: [
95
95
  // *Another use case is if you want to add callbacks to the methods at load time.
96
96
  manualLoad: false,
97
97
 
98
+ // Can be used to override where the SDK should be loaded from. This is useful
99
+ // if you want to serve the SDK from a custom domain other than RudderStack to tackle ad-blockers
100
+ // By default, the plugin will use the latest JS SDK from RudderStack's CDN
101
+ sdkURL: `https://subdomain.yourdomain.com/v1.1/rudder-analytics.min.js`,
102
+
98
103
  // string ('async' or 'defer'); whether to load the RudderStack SDK async or defer. Anything else
99
104
  // will load normally.
100
105
  // 'async' will load the SDK as <script async></script>
@@ -103,6 +108,8 @@ plugins: [
103
108
 
104
109
  // Options to the `load` API
105
110
  // Note: The above `controlPlaneUrl` overrides the `configUrl` field in this object
111
+ // You can find all the available load options here,
112
+ // https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-javascript-sdk/load-js-sdk/#loading-options
106
113
  loadOptions: {
107
114
  ...
108
115
  }
package/gatsby-browser.js CHANGED
@@ -3,51 +3,34 @@
3
3
  exports.onRouteUpdate = function (_ref, _ref2) {
4
4
  var prevLocation = _ref.prevLocation;
5
5
  var trackPage = _ref2.trackPage,
6
- _ref2$trackPageDelay = _ref2.trackPageDelay,
7
- trackPageDelay = _ref2$trackPageDelay === undefined ? 50 : _ref2$trackPageDelay;
8
-
6
+ _ref2$trackPageDelay = _ref2.trackPageDelay,
7
+ trackPageDelay = _ref2$trackPageDelay === void 0 ? 50 : _ref2$trackPageDelay;
9
8
  function trackRudderStackPage() {
10
9
  if (trackPage) {
11
- // Adding a delay (defaults to 50ms when not provided by plugin option `trackPageDelay`)
12
- // ensure that the RudderStack route tracking is in sync with the actual Gatsby route
13
- // (otherwise you can end up in a state where the RudderStack page tracking reports
14
- // the previous page on route change).
15
10
  var delay = Math.max(0, trackPageDelay);
16
-
17
11
  window.setTimeout(function () {
18
12
  window.rudderanalytics && window.rudderanalytics.page(document.title);
19
13
  }, delay);
20
14
  }
21
15
  }
22
-
23
- // IMPORTANT: If you are cloning the contents of this file,
24
- // we recommend to keep this section of the code intact and
25
- // just change the tracking logic in `trackRudderStackPage` method.
26
16
  if (window.rudderSnippetLoaded === false) {
27
17
  if (window.rudderSnippetLoading === true) {
28
- // As the loading is in progress, set the alternate callback function
29
- // to track page
30
18
  window.rudderSnippetLoadedCallback = function () {
31
19
  trackRudderStackPage();
32
20
  };
33
21
  } else {
34
- // if it is not the first page
35
22
  if (prevLocation) {
36
- // Trigger the script loader and set the callback function
37
- // to track page
38
23
  window.rudderSnippetLoadedCallback = undefined;
39
24
  window.rudderSnippetLoader(function () {
40
25
  trackRudderStackPage();
41
26
  });
42
- } else {
43
- // As this is the first page, set the alternate callback function
44
- // to track page and wait for the scroll event to occur (for SDK to get loaded)
27
+ } else {
45
28
  window.rudderSnippetLoadedCallback = function () {
46
29
  trackRudderStackPage();
47
- }
30
+ };
48
31
  }
49
32
  }
50
33
  } else {
51
34
  trackRudderStackPage();
52
35
  }
53
- };
36
+ };
package/gatsby-ssr.js CHANGED
@@ -1,136 +1,56 @@
1
1
  "use strict";
2
2
 
3
- var _react = require("react");
4
-
5
- var _react2 = _interopRequireDefault(_react);
6
-
7
- function _interopRequireDefault(obj) {
8
- return obj && obj.__esModule ? obj : { default: obj };
9
- }
10
-
3
+ var _react = _interopRequireDefault(require("react"));
4
+ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
5
+ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
6
+ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
7
+ function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
11
8
  exports.onRenderBody = function (_ref, pluginOptions) {
12
9
  var setHeadComponents = _ref.setHeadComponents;
13
- var trackPage = pluginOptions.trackPage,
14
- prodKey = pluginOptions.prodKey,
10
+ var prodKey = pluginOptions.prodKey,
15
11
  devKey = pluginOptions.devKey,
16
12
  _pluginOptions$dataPl = pluginOptions.dataPlaneUrl,
17
- dataPlaneUrl =
18
- _pluginOptions$dataPl === undefined
19
- ? "https://hosted.rudderlabs.com"
20
- : _pluginOptions$dataPl,
13
+ dataPlaneUrl = _pluginOptions$dataPl === void 0 ? "https://hosted.rudderlabs.com" : _pluginOptions$dataPl,
21
14
  controlPlaneUrl = pluginOptions.controlPlaneUrl,
22
15
  delayLoad = pluginOptions.delayLoad,
23
16
  delayLoadTime = pluginOptions.delayLoadTime,
24
17
  manualLoad = pluginOptions.manualLoad,
25
18
  loadType = pluginOptions.loadType,
26
- useNewSDK = pluginOptions.useNewSDK,
27
- loadOptions = pluginOptions.loadOptions,
28
- sdkURL = pluginOptions.sdkURL;
19
+ _pluginOptions$sdkURL = pluginOptions.sdkURL,
20
+ sdkURL = _pluginOptions$sdkURL === void 0 ? "https://cdn.rudderlabs.com/v1.1/rudder-analytics.min.js" : _pluginOptions$sdkURL,
21
+ _pluginOptions$loadOp = pluginOptions.loadOptions,
22
+ loadOptions = _pluginOptions$loadOp === void 0 ? {} : _pluginOptions$loadOp;
29
23
 
30
- var sdkSrc = "https://cdn.rudderlabs.com/v1/rudder-analytics.min.js";
31
- if (sdkURL) sdkSrc = sdkURL;
32
- else if (useNewSDK) {
33
- sdkSrc = "https://cdn.rudderlabs.com/v1.1/rudder-analytics.min.js";
34
- }
24
+ if (!prodKey || prodKey.length < 10) console.error("Your RudderStack prodKey must be at least 10 char in length.");
35
25
 
36
- if (!prodKey || prodKey.length < 10)
37
- console.error(
38
- "Your RudderStack prodKey must be at least 10 char in length."
39
- );
40
-
41
- if (devKey && devKey.length < 10)
42
- console.error(
43
- "If present, your RudderStack devKey must be at least 10 char in length."
44
- );
26
+ if (devKey && devKey.length < 10) console.error("If present, your RudderStack devKey must be at least 10 char in length.");
45
27
 
46
28
  var writeKey = process.env.NODE_ENV === "production" ? prodKey : devKey;
47
29
 
48
- var loadConfig = "'" + writeKey + "', '" + dataPlaneUrl + "'";
49
-
50
- if (loadOptions) {
51
- // Override config URL if provided separately
52
- loadOptions.configUrl = controlPlaneUrl || loadOptions.configUrl;
53
- loadConfig += ", " + JSON.stringify(loadOptions);
30
+ var finalLoadOptions = _objectSpread(_objectSpread({}, loadOptions), {}, {
31
+ configUrl: controlPlaneUrl || loadOptions.configUrl
32
+ });
33
+ var loadConfig = "'".concat(writeKey, "', '").concat(dataPlaneUrl, "', ").concat(JSON.stringify(finalLoadOptions));
34
+ var scriptTagStr = "var s = document.createElement(\"script\");\n s.type = \"text/javascript\";\n s.src = \"".concat(sdkURL, "\";");
35
+ if (loadType === "async") {
36
+ scriptTagStr += "s.async = true;";
37
+ } else if (loadType === "defer") {
38
+ scriptTagStr += "s.defer = true;";
54
39
  }
40
+ scriptTagStr += "document.head.appendChild(s);";
41
+ var snippet = "rudderanalytics=window.rudderanalytics=[];for(var methods=[\"load\",\"page\",\"track\",\"identify\",\"alias\",\"group\",\"ready\",\"reset\",\"getAnonymousId\",\"setAnonymousId\"],i=0;i<methods.length;i++){var method=methods[i];rudderanalytics[method]=function(a){return function(){rudderanalytics.push([a].concat(Array.prototype.slice.call(arguments)))}}(method)}\n ".concat(scriptTagStr, "\n");
42
+ var instantLoader = "".concat(snippet).concat(manualLoad ? "" : "rudderanalytics.load(".concat(loadConfig, ")"), ";");
43
+ var delayedLoader = "\n window.rudderSnippetLoaded = false;\n window.rudderSnippetLoading = false;\n window.rudderSnippetLoadedCallback = undefined;\n window.rudderSnippetLoader = function (callback) {\n if (!window.rudderSnippetLoaded && !window.rudderSnippetLoading) {\n window.rudderSnippetLoading = true;\n function loader() {\n ".concat(snippet, "\n window.rudderanalytics.load(").concat(loadConfig, ");\n window.rudderSnippetLoading = false;\n window.rudderSnippetLoaded = true;\n if (callback) { callback(); }\n if (window.rudderSnippetLoadedCallback) {\n window.rudderSnippetLoadedCallback();\n window.rudderSnippetLoadedCallback = undefined;\n }\n };\n\n \"requestIdleCallback\" in window\n ? requestIdleCallback(function () { loader(); })\n : loader();\n }\n }\n window.addEventListener('scroll',function () {window.rudderSnippetLoader()}, { once: true });\n setTimeout(\n function () {\n \"requestIdleCallback\" in window\n ? requestIdleCallback(function () { window.rudderSnippetLoader(); })\n : window.rudderSnippetLoader();\n },\n ").concat(delayLoadTime, " || 1000\n );\n ");
55
44
 
56
- var snippet =
57
- 'rudderanalytics=window.rudderanalytics=[];for(var methods=["load","page","track","identify","alias","group","ready","reset","getAnonymousId","setAnonymousId"],i=0;i<methods.length;i++){var method=methods[i];rudderanalytics[method]=function(a){return function(){rudderanalytics.push([a].concat(Array.prototype.slice.call(arguments)))}}(method)}\n ' +
58
- (delayLoad || manualLoad
59
- ? ""
60
- : "rudderanalytics.load(" + loadConfig + ")") +
61
- ";\n";
62
-
63
- const delayedLoader = `
64
- window.rudderSnippetLoaded = false;
65
- window.rudderSnippetLoading = false;
66
- window.rudderSnippetLoadedCallback = undefined;
67
- window.rudderSnippetLoader = function (callback) {
68
- if (!window.rudderSnippetLoaded && !window.rudderSnippetLoading) {
69
- window.rudderSnippetLoading = true;
70
- function loader() {
71
- window.rudderanalytics.load(${loadConfig});
72
- window.rudderSnippetLoading = false;
73
- window.rudderSnippetLoaded = true;
74
- if (callback) { callback(); }
75
- if (window.rudderSnippetLoadedCallback) {
76
- window.rudderSnippetLoadedCallback();
77
- window.rudderSnippetLoadedCallback = undefined;
78
- }
79
- };
80
-
81
- "requestIdleCallback" in window
82
- ? requestIdleCallback(function () { loader(); })
83
- : loader();
84
- }
85
- }
86
- window.addEventListener('scroll',function () {window.rudderSnippetLoader()}, { once: true });
87
- setTimeout(
88
- function () {
89
- "requestIdleCallback" in window
90
- ? requestIdleCallback(function () { window.rudderSnippetLoader(); })
91
- : window.rudderSnippetLoader();
92
- },
93
- ${delayLoadTime} || 1000
94
- );
95
- `;
96
-
97
- var snippetToUse =
98
- "\n " +
99
- (delayLoad && !manualLoad ? delayedLoader : "") +
100
- "\n " +
101
- snippet +
102
- "\n ";
45
+ var snippetToUse = "".concat(delayLoad && !manualLoad ? delayedLoader : instantLoader);
103
46
 
104
47
  if (writeKey) {
105
- var tags = [
106
- _react2.default.createElement("script", {
107
- key: "plugin-rudderstack",
108
- dangerouslySetInnerHTML: { __html: snippetToUse },
109
- }),
110
- ];
111
-
112
- var tag = void 0;
113
-
114
- if (loadType == "async") {
115
- tag = _react2.default.createElement("script", {
116
- async: true,
117
- key: "rudderstack-cdn",
118
- src: sdkSrc,
119
- });
120
- } else if (loadType == "defer") {
121
- tag = _react2.default.createElement("script", {
122
- defer: true,
123
- key: "rudderstack-cdn",
124
- src: sdkSrc,
125
- });
126
- } else {
127
- tag = _react2.default.createElement("script", {
128
- key: "rudderstack-cdn",
129
- src: sdkSrc,
130
- });
131
- }
132
-
133
- tags.push(tag);
48
+ var tags = [_react["default"].createElement("script", {
49
+ key: "plugin-rudderstack",
50
+ dangerouslySetInnerHTML: {
51
+ __html: snippetToUse
52
+ }
53
+ })];
134
54
  setHeadComponents(tags);
135
55
  }
136
- };
56
+ };
package/package.json CHANGED
@@ -1,11 +1,26 @@
1
1
  {
2
2
  "name": "gatsby-plugin-rudderstack",
3
- "version": "1.1.1",
3
+ "version": "2.0.0",
4
4
  "description": "Event tracking with RudderStack in your Gatsby frontend.",
5
5
  "main": "gatsby-ssr.js",
6
6
  "scripts": {
7
- "build": "babel src --out-dir . --ignore __tests__",
8
- "watch": "babel -w src --out-dir . --ignore __tests__"
7
+ "build": "babel src --out-dir ./dist --ignore __tests__ && npm run copy:files",
8
+ "watch": "babel -w src --out-dir ./dist --ignore __tests__",
9
+ "clean": "rm -rf dist",
10
+ "check:lint": "eslint \"src/**/*.js\"",
11
+ "check:lint:ci": "eslint \"src/**/*.js\" -f json -o reports/eslint.json || exit 0",
12
+ "check:circular": "madge --circular --extensions js ./src || exit 0",
13
+ "check:duplicates": "jscpd src --threshold 5",
14
+ "check:security": "npm audit --recursive --audit-level=high",
15
+ "format": "prettier --write .",
16
+ "lint:fix": "eslint . --fix",
17
+ "prepare": "husky install",
18
+ "pre-commit": "npm run test && npx lint-staged",
19
+ "commit-msg": "commitlint --edit",
20
+ "commit": "git-cz",
21
+ "test": "exit 0",
22
+ "test:ci": "exit 0",
23
+ "copy:files": "cp CHANGELOG.md dist/ && cp LICENSE.md dist/ && cp package.json dist/ && cp gatsby-node.js dist/ && cp README.md dist/"
9
24
  },
10
25
  "repository": {
11
26
  "type": "git",
@@ -19,19 +34,65 @@
19
34
  "gatsby-plugin"
20
35
  ],
21
36
  "author": "RudderStack",
22
- "license": "AGPL-3.0-only",
37
+ "license": "MIT",
23
38
  "bugs": {
24
39
  "url": "https://github.com/rudderlabs/gatsby-plugin-rudderstack/issues"
25
40
  },
26
41
  "homepage": "https://github.com/rudderlabs/gatsby-plugin-rudderstack#readme",
27
42
  "devDependencies": {
28
- "babel-cli": "^6.24.1",
29
- "babel-preset-env": "^1.6.1",
30
- "babel-preset-react": "^6.24.1"
43
+ "@babel/cli": "^7.19.3",
44
+ "@babel/core": "^7.20.2",
45
+ "@babel/eslint-parser": "7.19.1",
46
+ "@babel/plugin-proposal-object-rest-spread": "^7.20.2",
47
+ "@babel/preset-env": "^7.20.2",
48
+ "@babel/preset-react": "^7.18.6",
49
+ "commitizen": "4.2.5",
50
+ "commitlint": "17.3.0",
51
+ "conventional-changelog-cli": "2.2.2",
52
+ "conventional-github-releaser": "3.1.5",
53
+ "@commitlint/config-conventional": "17.3.0",
54
+ "@digitalroute/cz-conventional-changelog-for-jira": "7.4.2",
55
+ "eslint": "8.28.0",
56
+ "eslint-config-airbnb": "19.0.4",
57
+ "eslint-config-airbnb-base": "15.0.0",
58
+ "eslint-config-prettier": "8.5.0",
59
+ "eslint-plugin-compat": "4.0.2",
60
+ "eslint-plugin-import": "2.26.0",
61
+ "eslint-plugin-sonarjs": "0.16.0",
62
+ "eslint-plugin-unicorn": "45.0.0",
63
+ "husky": "8.0.2",
64
+ "jscpd": "3.5.1",
65
+ "lint-staged": "13.0.4",
66
+ "madge": "5.0.1",
67
+ "prettier": "2.8.0",
68
+ "standard-version": "9.5.0"
31
69
  },
32
70
  "eslintConfig": {
33
71
  "rules": {
34
72
  "strict": "off"
35
73
  }
74
+ },
75
+ "lint-staged": {
76
+ "*.js": "eslint --cache --fix",
77
+ "*.{json,js,md,ts}": "prettier --write"
78
+ },
79
+ "config": {
80
+ "commitizen": {
81
+ "path": "./node_modules/@digitalroute/cz-conventional-changelog-for-jira",
82
+ "jiraMode": false,
83
+ "jiraOptional": true,
84
+ "skipScope": true,
85
+ "defaultType": "feat"
86
+ }
87
+ },
88
+ "overrides": {
89
+ "dot-prop": "5.3.0",
90
+ "semver-regex": "3.1.4",
91
+ "trim-newlines": "3.0.1"
92
+ },
93
+ "resolutions": {
94
+ "dot-prop": "5.3.0",
95
+ "semver-regex": "3.1.4",
96
+ "trim-newlines": "3.0.1"
36
97
  }
37
98
  }
@@ -1,39 +0,0 @@
1
- ---
2
- name: Bug report
3
- about: Create a report to help us improve
4
- title: "[ISSUE]"
5
- labels: bug
6
- assignees: ''
7
-
8
- ---
9
-
10
- **Describe the issue**
11
- Enter a clear and concise description of what the bug/issue is.
12
-
13
- **To Reproduce**
14
- Mention the steps to reproduce the behavior that causes the bug/issue:
15
-
16
- 1. Go to '...'
17
- 2. Click on '....'
18
- 3. Scroll down to '....'
19
- 4. See error
20
-
21
- **Expected behavior**
22
- A clear and concise description of what you expected to happen.
23
-
24
- **Screenshots**
25
- If applicable, add screenshots to help explain your problem.
26
-
27
- **Desktop (please complete the following information):**
28
- - OS: [e.g. iOS]
29
- - Browser [e.g. chrome, safari]
30
- - Version [e.g. 22]
31
-
32
- **Smartphone (please complete the following information):**
33
- - Device: [e.g. iPhone6]
34
- - OS: [e.g. iOS8.1]
35
- - Browser [e.g. stock browser, safari]
36
- - Version [e.g. 22]
37
-
38
- **Additional context**
39
- Add any other context about the problem here.
@@ -1,20 +0,0 @@
1
- ---
2
- name: Feature Request
3
- about: Suggest an idea for this project
4
- title: "[ENHANCEMENT]"
5
- labels: enhancement
6
- assignees: ''
7
-
8
- ---
9
-
10
- **Is your feature request related to a problem? Please describe.**
11
- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12
-
13
- **Describe the solution you'd like**
14
- A clear and concise description of what you want to happen.
15
-
16
- **Describe alternatives you've considered**
17
- A clear and concise description of any alternative solutions or features you've considered.
18
-
19
- **Additional context**
20
- Add any other context or screenshots about the feature request here.
@@ -1,13 +0,0 @@
1
- **Fixes** # (*issue*)
2
-
3
- ## Type of change
4
- - [ ] Bug fix (non-breaking change which fixes an issue)
5
- - [ ] New feature (non-breaking change which adds functionality)
6
- - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
7
- - [ ] This change requires a documentation update
8
- ## Checklist:
9
- - [ ] My code follows the style guidelines of this project
10
- - [ ] I have performed a self-review of my own code
11
- - [ ] I have commented my code, particularly in hard-to-understand areas
12
- - [ ] I have added unit tests for the code
13
- - [ ] I have made corresponding changes to the documentation
package/CODEOWNERS DELETED
@@ -1,2 +0,0 @@
1
- * @thtmnisamnstr
2
- * @cwray-tech
@@ -1,80 +0,0 @@
1
- # Contributor Covenant Code of Conduct
2
-
3
- ## Our Pledge
4
-
5
- In the interest of fostering an open and welcoming environment, we as
6
- contributors and maintainers pledge to making participation in our project and
7
- our community a harassment-free experience for everyone, regardless of age, body
8
- size, disability, ethnicity, sex characteristics, gender identity and expression,
9
- level of experience, education, socio-economic status, nationality, personal
10
- appearance, race, religion, or sexual identity and orientation.
11
-
12
- ## Our Standards
13
-
14
- Examples of behavior that contributes to creating a positive environment
15
- include:
16
-
17
- * Using welcoming and inclusive language
18
- * Being respectful of differing viewpoints and experiences
19
- * Gracefully accepting constructive criticism
20
- * Focusing on what is best for the community
21
- * Showing empathy towards other community members
22
-
23
- Examples of unacceptable behavior by participants include:
24
-
25
- * The use of sexualized language or imagery and unwelcome sexual attention or
26
- advances
27
- * Trolling, insulting/derogatory comments, and personal or political attacks
28
- * Public or private harassment
29
- * Publishing others' private information, such as a physical or electronic
30
- address, without explicit permission
31
- * Other conduct which could reasonably be considered inappropriate in a
32
- professional setting
33
-
34
- ## Our Responsibilities
35
-
36
- Project maintainers are responsible for clarifying the standards of acceptable
37
- behavior and are expected to take appropriate and fair corrective action in
38
- response to any instances of unacceptable behavior.
39
-
40
- Project maintainers have the right and responsibility to remove, edit, or
41
- reject comments, commits, code, wiki edits, issues, and other contributions
42
- that are not aligned to this Code of Conduct, or to ban temporarily or
43
- permanently any contributor for other behaviors that they deem inappropriate,
44
- threatening, offensive, or harmful.
45
-
46
- ## Scope
47
-
48
- This Code of Conduct applies both within project spaces and in public spaces
49
- when an individual is representing the project or its community. Examples of
50
- representing a project or community include using an official project e-mail
51
- address, posting via an official social media account, or acting as an appointed
52
- representative at an online or offline event. Representation of a project may be
53
- further defined and clarified by project maintainers.
54
-
55
- ## Enforcement
56
-
57
- Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
- reported by contacting the project team at **contact@rudderstack.com**. All
59
- complaints will be reviewed and investigated and will result in a response that
60
- is deemed necessary and appropriate to the circumstances. The project team is
61
- obligated to maintain confidentiality with regard to the reporter of an incident.
62
- Further details of specific enforcement policies may be posted separately.
63
-
64
- Project maintainers who do not follow or enforce the Code of Conduct in good
65
- faith may face temporary or permanent repercussions as determined by other
66
- members of the project's leadership.
67
-
68
- ## Attribution
69
-
70
- This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
- available at [https://www.contributor-covenant.org][contributor-covenant].
72
-
73
- For answers to common questions about this code of conduct, see the [FAQs][faqs].
74
-
75
-
76
- <!-----variables---->
77
-
78
- [homepage]: https://www.contributor-covenant.org
79
- [contributor-covenant]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
80
- [faqs]: https://www.contributor-covenant.org/faq
package/CONTRIBUTING.md DELETED
@@ -1,47 +0,0 @@
1
- # Contributing to RudderStack #
2
-
3
- Thanks for taking the time and for your help improving this project!
4
-
5
- ## Getting Help ##
6
-
7
- If you have a question about rudder or have encountered problems using it,
8
- start by asking a question on [Slack][slack].
9
-
10
- ## Rudder Labs Contributor Agreement ##
11
-
12
- To contribute to this project, we need you to sign to [Contributor License Agreement (“CLA”)][CLA] for the first commit you make. By agreeing to the [CLA][CLA]
13
- we can add you to list of approved contributors and review the changes proposed by you.
14
-
15
- ## Installing and Setting Up \*\* Software Name \*\*
16
-
17
- \*\* Describe, in detail, how to setup and start using the software. \*\*
18
-
19
- ## Submitting a Pull Request ##
20
-
21
- Do you have an improvement?
22
-
23
- 1. Submit an [issue][issue] describing your proposed change.
24
- 2. We will try to respond to your issue promptly.
25
- 3. Fork this repo, develop and test your code changes. See the project's [README](README.md) for further information about working in this repository.
26
- 4. Submit a pull request against this repo's `main` branch.
27
- - Include instructions on how to test your changes.
28
- 5. Your branch may be merged once all configured checks pass, including:
29
- - A review from appropriate maintainers
30
-
31
- ## Committing ##
32
-
33
- We prefer squash or rebase commits so that all changes from a branch are
34
- committed to master as a single commit. All pull requests are squashed when
35
- merged, but rebasing prior to merge gives you better control over the commit
36
- message.
37
-
38
- We look forward to your feedback on improving this project.
39
-
40
-
41
- <!----variable's---->
42
-
43
- \*\* Update variable links. \*\*
44
-
45
- [slack]: https://resources.rudderstack.com/join-rudderstack-slack
46
- [issue]: https://github.com/rudderlabs/rudder-repo-template/issues/new
47
- [CLA]: https://rudderlabs.wufoo.com/forms/rudderlabs-contributor-license-agreement
package/index.js DELETED
@@ -1 +0,0 @@
1
- // noop