2022 11 07 merge with tradingview master

.circleci/config.yml

@@ -42,11 +42,11 @@ aliases:
 executors:
   node16-executor:
     docker:
-      - image: circleci/node:16
+      - image: cimg/node:16.16
 
   node16-browsers-executor:
     docker:
-      - image: circleci/node:16-browsers
+      - image: cimg/node:16.16-browsers
 
 commands:
   checkout-with-deps:
@@ -74,7 +74,10 @@ commands:
             echo 'export TESTS_REPORT_FILE="test-results/graphics/results.xml"' >> $BASH_ENV
             echo 'export DEVICE_PIXEL_RATIO=<< parameters.devicePixelRatio >>' >> $BASH_ENV
             echo 'export PRODUCTION_BUILD=<< parameters.productionBuild >>' >> $BASH_ENV
-      - run: scripts/run-graphics-tests.sh
+      - run:
+          command: scripts/run-graphics-tests.sh
+          no_output_timeout: 20m
+
       - store_test_results:
           path: test-results/
       - store_artifacts:
@@ -101,10 +104,10 @@ jobs:
     executor: node16-executor
     steps:
       - checkout-with-deps
+      - run: npm run build:prod
       # make sure that the project is compiled successfully with composite projects
       # so we don't have cyclic deps between projects and wrong imports
       - run: npm run tsc-verify
-      - run: npm run build:prod
       - persist_to_workspace:
           root: ./
           paths:
@@ -127,6 +130,8 @@ jobs:
     executor: node16-executor
     steps:
       - checkout-with-deps
+      - attach_workspace:
+          at: ./
       - run: npm run lint:eslint
 
   lint-dts:
@@ -215,6 +220,19 @@ jobs:
       - store_test_results:
           path: test-results/
 
+  interactions:
+    executor: node16-browsers-executor
+    environment:
+      NO_SANDBOX: "true"
+      TESTS_REPORT_FILE: "test-results/interactions/results.xml"
+    steps:
+      - checkout-with-deps
+      - attach_workspace:
+          at: ./
+      - run: scripts/run-interactions-tests.sh
+      - store_test_results:
+          path: test-results/
+
   size-limit:
     executor: node16-executor
     steps:
@@ -230,8 +248,7 @@ jobs:
     executor: node16-executor
     steps:
       - checkout-with-deps
-      - run: npm run tsc
-      - run: npm run bundle-dts
+      - run: npm run build:prod
       - run:
           name: "Install dependencies and build website"
           command: |
@@ -290,10 +307,7 @@ workflows:
           filters: *default-filters
           requires:
             - install-deps
-      - lint-eslint:
-          filters: *default-filters
-          requires:
-            - install-deps
+            - install-deps-website
       - lint-markdown:
           filters: *default-filters
           requires:
@@ -335,17 +349,18 @@ workflows:
           filters: *default-filters
           requires:
             - build
-      - lint-dts:
+      - interactions:
           filters: *default-filters
           requires:
             - build
-
-  website:
-    jobs:
-      - install-deps:
+      - lint-dts:
           filters: *default-filters
-      - install-deps-website:
+          requires:
+            - build
+      - lint-eslint:
           filters: *default-filters
+          requires:
+            - build
       - build-docusaurus-website:
           filters: *default-filters
           requires:

.eslintrc.js

@@ -1,21 +1,11 @@
 function getNamingConventionRules(additionalDefaultFormats = []) {
 	return [
 		{ selector: 'default', format: ['camelCase', ...additionalDefaultFormats], leadingUnderscore: 'forbid', trailingUnderscore: 'forbid' },
-
 		{ selector: 'variable', format: ['camelCase', 'UPPER_CASE', ...additionalDefaultFormats] },
-		// {
-		// 	selector: 'variable',
-		// 	types: ['boolean'],
-		// 	format: ['PascalCase'],
-		// 	prefix: ['is', 'should', 'has', 'can', 'did', 'will', 'show', 'enable', 'need'],
-		// },
-
 		{ selector: 'typeLike', format: ['PascalCase'] },
 		{ selector: 'enumMember', format: ['PascalCase'] },
-
 		{ selector: 'memberLike', modifiers: ['private'], leadingUnderscore: 'require', format: ['camelCase'] },
 		{ selector: 'memberLike', modifiers: ['protected'], leadingUnderscore: 'require', format: ['camelCase'] },
-
 		{
 			selector: 'property',
 			format: ['PascalCase'],
@@ -24,8 +14,6 @@ function getNamingConventionRules(additionalDefaultFormats = []) {
 				regex: '^(Area|Baseline|Bar|Candlestick|Histogram|Line)$',
 			},
 		},
-
-		// { selector: 'typeParameter', format: ['PascalCase'], prefix: ['T', 'U'] },
 	];
 }
 
@@ -59,6 +47,7 @@ module.exports = {
 		'prefer-arrow',
 		'unicorn',
 		'jsdoc',
+		'eslint-plugin-react',
 	],
 	settings: {
 		jsdoc: {
@@ -73,7 +62,7 @@ module.exports = {
 		'plugin:react/recommended',
 	],
 	parserOptions: {
-		ecmaVersion: 2019,
+		ecmaVersion: 2020,
 		sourceType: 'module',
 	},
 	overrides: [
@@ -94,6 +83,7 @@ module.exports = {
 					},
 					rules: {
 						'react/prop-types': 'off',
+						'import/no-default-export': 'off',
 					},
 				},
 			],
@@ -180,8 +170,8 @@ module.exports = {
 				'no-undef': 'off',
 				'no-unused-vars': 'off',
 				indent: ['error', 4],
-
 				'unicorn/filename-case': 'off',
+				'react/prop-types': 'off',
 			},
 		},
 		{
@@ -195,7 +185,7 @@ module.exports = {
 			},
 			overrides: [
 				{
-					files: ['website/**/*.tsx'],
+					files: ['website/**/*.ts', 'website/**/*.tsx'],
 					parserOptions: {
 						project: 'website/tsconfig.json',
 						sourceType: 'module',

.gitignore

@@ -27,8 +27,10 @@ debug.html
 /website/.docusaurus
 /website/.cache-loader
 /website/.previous-typings-cache/*.d.ts
+/website/versions.d.ts
 
 !/src/typings/**/*.d.ts
 
 # graphics tests out data
 /tests/e2e/graphics/.gendata/
+tests/e2e/coverage/.gendata

.vscode/launch.json

@@ -41,6 +41,16 @@
                 "${input:testStandalonePath}"
             ],
             "internalConsoleOptions": "openOnSessionStart"
+        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Interaction tests",
+            "program": "${workspaceFolder}/tests/e2e/interactions/runner.js",
+            "args": [
+                "${input:testStandalonePath}"
+            ],
+            "internalConsoleOptions": "openOnSessionStart"
         }
     ],
     "inputs": [

.vscode/settings.json

@@ -3,6 +3,7 @@
         "dist/**": true,
         "lib/**": true,
         "tests/e2e/graphics/.gendata/**": true,
+        "tests/e2e/coverage/.gendata/**": true,
         "website/.docusaurus/**": true,
         "website/build/**": true,
         "website/docs/api/**": true,

BUILDING.md

@@ -1,6 +1,8 @@
 # Building Lightweight Charts
 
-The minimal supported version of [NodeJS](https://nodejs.org/) for development is 16.13.
+The minimal supported version of [NodeJS](https://nodejs.org/) for development is 16.16.
+
+**Note:** you need to run `npm install` in both the root directory and the `website` directory before you can run the lint tests.
 
 ## Compiling
 
@@ -19,6 +21,8 @@ The minimal supported version of [NodeJS](https://nodejs.org/) for development i
 - `npm run lint` - runs lint for the code
 - `npm run test` - runs unit-tests
 
+There are several included e2e tests available which can be run individually. Please have a read through the following document for further information: [/tests/README.md](./tests/README.md)
+
 ## Tips
 
 - You can use the following command to make sure that your local copy passes all (almost) available checks:
@@ -34,6 +38,7 @@ The minimal supported version of [NodeJS](https://nodejs.org/) for development i
 1. Run `npm run docusaurus docs:version MAJ:MIN` in `website` folder to create new versioned docs.
   Note that there is not patch version in docs, only major and minor parts.
 1. (optional) Remove docs for the oldest version (see <https://docusaurus.io/docs/versioning#deleting-an-existing-version>).
+1. Handle the new version in `import-lightweight-charts-version.ts`: add a package reference for that version to `website/package.json` (e.g. `"lightweight-charts-MAJ.MIN": "npm:lightweight-charts@~MAJ.MIN.0"`) and a import of that package in a matching case statement.
 1. Bump `lightweight-charts` package version in `website/package.json` file.
 1. Add all created files to git and commit changes.
   Note that at this step the website cannot work since it uses unpublished so far version. It will be fixed in the next steps.

CONTRIBUTING.md

@@ -32,7 +32,7 @@ When logging a bug, please be sure to include the following:
 ### Tests
 
 1. Every pull request should have an adequate tests whenever it's possible (we have several [type of tests](./tests/), so you can find what works best for your changes).
-1. If your changes affect paining, then your changes should contain a test case (or test cases) for [graphics tests](./tests/e2e/graphics).
+1. If your changes affect painting, then your changes should contain a test case (or test cases) for [graphics tests](./tests/e2e/graphics).
 1. Your pull request should pass CI (except checks marked as "not required" - in this case a reviewer should pay attention to job's artifacts).
 
 ### Git commit messages

README.md

@@ -1,3 +1,22 @@
+# About this fork
+
+This is a fork of TradingView's [Lightweight Charts](https://github.com/tradingview/lightweight-charts).
+I needed certain features that weren't included yet (and maybe never) in the official version of LWC.
+Specifically, I have an application that is very much like TradingView.com where each window can contain multiple charts, and each chart can have multiple indicator panes.
+
+[John Wallace](https://github.com/john-wallace-dev)
+March 2022
+
+## Multiple Panes
+
+Allows multiple panes below the main chart. I use them to display interactive indicators below the main chart. Implemented by [ntf](https://github.com/ntf) to satisfy requests from [Lightweight Charts issue 50](https://github.com/tradingview/lightweight-charts/issues/50).
+
+## Setting Crosshair Position
+
+Allows you to programmatically set the crosshair, which is useful when you want to synchronize the crosshair between multiple charts on one screen. Implemented by [trior](https://github.com/triorr) to satisfy requests from [Lightweight Charts issue 438](https://github.com/tradingview/lightweight-charts/issues/438).
+
+## From Main Branch
+
 <!-- markdownlint-disable no-inline-html first-line-h1 -->
 
 <div align="center">
@@ -16,7 +35,7 @@
 
 <!-- markdownlint-enable no-inline-html -->
 
-[Demos][demo-url] | [Documentation](https://tradingview.github.io/lightweight-charts/) | [Discord community](https://discord.gg/UC7cGkvn4U)
+[Demos][demo-url] | [Documentation](https://tradingview.github.io/lightweight-charts/) | [Discord community](https://discord.gg/UC7cGkvn4U) | [Reddit](https://www.reddit.com/r/TradingView/)
 
 TradingView Lightweight Charts are one of the smallest and fastest financial HTML5 charts.