Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/tracy side by side #81

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
/* eslint-env node */
module.exports = {
extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', "plugin:react/recommended"],
parser: '@typescript-eslint/parser',
plugins: ['@typescript-eslint', "react"],
root: true,
rules: {
"no-useless-escape": "off",
"no-mixed-spaces-and-tabs": ["error", "smart-tabs"],
"@typescript-eslint/no-non-null-assertion": "off",
"@typescript-eslint/naming-convention": [
"error",
{
"selector": "variable",
"format": ["camelCase","PascalCase","UPPER_CASE"]
}
],
'react/jsx-uses-react': "error",
'react/jsx-uses-vars': "error",
}
/* eslint-env node */
module.exports = {
extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', "plugin:react/recommended"],
parser: '@typescript-eslint/parser',
plugins: ['@typescript-eslint', "react"],
root: true,
rules: {
"no-useless-escape": "off",
"no-mixed-spaces-and-tabs": ["error", "smart-tabs"],
"@typescript-eslint/no-non-null-assertion": "off",
"@typescript-eslint/naming-convention": [
"error",
{
"selector": "variable",
"format": ["camelCase","PascalCase","UPPER_CASE"]
}
],
'react/jsx-uses-react': "error",
'react/jsx-uses-vars': "error",
}
};
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ node_modules/
out/
workspace/
*.vsix
examples/*.tracy.json
examples/*.tracy.json
!log/
24 changes: 12 additions & 12 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
node_modules/
out/
workspace/
media/
examples/
.eslintrc.cjs
.github/
.vscode/
*.vsix
README.md
webpack.config.ts
tsconfig.json
node_modules/
out/
workspace/
media/
examples/
.eslintrc.cjs
.github/
.vscode/
*.vsix
README.md
webpack.config.ts
tsconfig.json
src/extension
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Tracy is a Visual Studio Code extension for the analysis of logs. It is meant as
</div>

## Installation
To install Tracy in Visual Studio Code:
To install Tracy in Visual Studio Code: test
1. Obtain the plugin `.vsix` file:
- If you want to install the latest release, go to the [Latest release](https://github.com/TNO/vscode-tracy/releases/latest) and download the `vscode-tracy-X.X.X.vsix` file under *Assests*.
- If you want to install a specific commit, click on the :heavy_check_mark: next to the commit -> *Details* -> *Summary* -> under *Artifacts*, *vscode-vsix* and extract the downloaded `vscode-vsix.zip`.
Expand Down Expand Up @@ -44,6 +44,15 @@ A prominent feature is the minimap, which allows navigation and analysis of a lo

The minimap can be scaled (zoomed out and in) by holding the Control key and at the same time turning the mouse wheel, while the pointer is positioned over the minimap. The lines (rows) of the log that are visible, are indicated by a shaded area in the minimap. Scrolling the log is done with the scroll bar immediately to the left of the minimap, or by using the mouse wheel while the pointer is positioned over the log.

### Side by side comparison

**Comparing files:**
Open first file using the instructions above, then click the compare button and select the second file. To toggle synchronous scrolling, click the link button in the menu bar.

The feature allows comparison of two log files in one view including their minimaps. The initial log file is located on the left side and the second log file is located on the right side of the window with their minimaps being in the middle. The files have synchronized scrolling, which can be also toggled off. In case the scroll is synchronized and one file is shorter, you can still scroll the other one.

Copyright 2024 ASML Netherlands B.V

## User and Developer Documentation
For more information, check the [Tracy user and developer documentation](https://tno.github.io/vscode-tracy/).

Expand Down
118 changes: 59 additions & 59 deletions docs/developer-documentation/components/App.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,59 @@
# Component name
(Screenshot of component - Optional)
---
(Short description)
## Relations to other components
- **Parent:** ParentComponent
- **Children:**
- Child1
- Child2
## Props
| Name | Type | Description |
| ---- | ---- | ----------- |
| `prop1` | `type1` | short description |
| `prop2` | `type2` | short description |
| `prop3` | `type3` | short description |
## State
| Name | Type | Initial Value | Description |
| ---- | ---- | ------------- | ----------- |
| `stateObj1` | `type1` | `init value` | short description |
| `stateObj2` | `type1` | `init value` | short description |
| `stateObj3` | `type1` | `init value` | short description |
## Functions
### Component lifecycle functions
- ### `constructor(...)`
- **Params:**
- `props: Props`
- **Description:** Is invoked the first time the `StructureDialog` is opened. It constructs an array containing [StructureEntries](..\Types\StructureEntry.md) from the `logSelectedRows` props and updates the state accordingly.
- **Returns:** -
- ### `shouldComponentUpdate(...)`
- **Params:**
- `nextProps: Readonly<Props>`
- `nextState: Readonly<State>`
- `nextContext: any`
- **Description:** This function returns a `boolean` value that indicates whether or not rendering should be skipped. It returns `true` if ..., and ... otherwise.
- **Returns:** `boolean`
- ### `render()`
- **Description:**
- **Returns:** Div of type `JSX.Element` containing....
### Functionality-related functions
- ### `exampleFunctionWithNoParams()`
- **Description:** short description of what happens in the function.
- **Returns:** -
- ### `exampleFunctionWithParams(...)`
- **Params:**
- `name: type`
- **Description:** short description of what happens in the function.
- **Returns:** -
# Component name
(Screenshot of component - Optional)

---
(Short description)

## Relations to other components

- **Parent:** ParentComponent
- **Children:**
- Child1
- Child2

## Props

| Name | Type | Description |
| ---- | ---- | ----------- |
| `prop1` | `type1` | short description |
| `prop2` | `type2` | short description |
| `prop3` | `type3` | short description |

## State

| Name | Type | Initial Value | Description |
| ---- | ---- | ------------- | ----------- |
| `stateObj1` | `type1` | `init value` | short description |
| `stateObj2` | `type1` | `init value` | short description |
| `stateObj3` | `type1` | `init value` | short description |

## Functions
### Component lifecycle functions
- ### `constructor(...)`
- **Params:**
- `props: Props`
- **Description:** Is invoked the first time the `StructureDialog` is opened. It constructs an array containing [StructureEntries](..\Types\StructureEntry.md) from the `logSelectedRows` props and updates the state accordingly.
- **Returns:** -

- ### `shouldComponentUpdate(...)`
- **Params:**
- `nextProps: Readonly<Props>`
- `nextState: Readonly<State>`
- `nextContext: any`
- **Description:** This function returns a `boolean` value that indicates whether or not rendering should be skipped. It returns `true` if ..., and ... otherwise.
- **Returns:** `boolean`

- ### `render()`
- **Description:**
- **Returns:** Div of type `JSX.Element` containing....

### Functionality-related functions
- ### `exampleFunctionWithNoParams()`
- **Description:** short description of what happens in the function.
- **Returns:** -

- ### `exampleFunctionWithParams(...)`
- **Params:**
- `name: type`
- **Description:** short description of what happens in the function.
- **Returns:** -
118 changes: 59 additions & 59 deletions docs/developer-documentation/components/ContextMenu.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,59 @@
# Component name
(Screenshot of component - Optional)
---
(Short description)
## Relations to other components
- **Parent:** ParentComponent
- **Children:**
- Child1
- Child2
## Props
| Name | Type | Description |
| ---- | ---- | ----------- |
| `prop1` | `type1` | short description |
| `prop2` | `type2` | short description |
| `prop3` | `type3` | short description |
## State
| Name | Type | Initial Value | Description |
| ---- | ---- | ------------- | ----------- |
| `stateObj1` | `type1` | `init value` | short description |
| `stateObj2` | `type1` | `init value` | short description |
| `stateObj3` | `type1` | `init value` | short description |
## Functions
### Component lifecycle functions
- ### `constructor(...)`
- **Params:**
- `props: Props`
- **Description:** Is invoked the first time the `StructureDialog` is opened. It constructs an array containing [StructureEntries](..\Types\StructureEntry.md) from the `logSelectedRows` props and updates the state accordingly.
- **Returns:** -
- ### `shouldComponentUpdate(...)`
- **Params:**
- `nextProps: Readonly<Props>`
- `nextState: Readonly<State>`
- `nextContext: any`
- **Description:** This function returns a `boolean` value that indicates whether or not rendering should be skipped. It returns `true` if ..., and ... otherwise.
- **Returns:** `boolean`
- ### `render()`
- **Description:**
- **Returns:** Div of type `JSX.Element` containing....
### Functionality-related functions
- ### `exampleFunctionWithNoParams()`
- **Description:** short description of what happens in the function.
- **Returns:** -
- ### `exampleFunctionWithParams(...)`
- **Params:**
- `name: type`
- **Description:** short description of what happens in the function.
- **Returns:** -
# Component name
(Screenshot of component - Optional)

---
(Short description)

## Relations to other components

- **Parent:** ParentComponent
- **Children:**
- Child1
- Child2

## Props

| Name | Type | Description |
| ---- | ---- | ----------- |
| `prop1` | `type1` | short description |
| `prop2` | `type2` | short description |
| `prop3` | `type3` | short description |

## State

| Name | Type | Initial Value | Description |
| ---- | ---- | ------------- | ----------- |
| `stateObj1` | `type1` | `init value` | short description |
| `stateObj2` | `type1` | `init value` | short description |
| `stateObj3` | `type1` | `init value` | short description |

## Functions
### Component lifecycle functions
- ### `constructor(...)`
- **Params:**
- `props: Props`
- **Description:** Is invoked the first time the `StructureDialog` is opened. It constructs an array containing [StructureEntries](..\Types\StructureEntry.md) from the `logSelectedRows` props and updates the state accordingly.
- **Returns:** -

- ### `shouldComponentUpdate(...)`
- **Params:**
- `nextProps: Readonly<Props>`
- `nextState: Readonly<State>`
- `nextContext: any`
- **Description:** This function returns a `boolean` value that indicates whether or not rendering should be skipped. It returns `true` if ..., and ... otherwise.
- **Returns:** `boolean`

- ### `render()`
- **Description:**
- **Returns:** Div of type `JSX.Element` containing....

### Functionality-related functions
- ### `exampleFunctionWithNoParams()`
- **Description:** short description of what happens in the function.
- **Returns:** -

- ### `exampleFunctionWithParams(...)`
- **Params:**
- `name: type`
- **Description:** short description of what happens in the function.
- **Returns:** -
Loading
Loading