phase2 / outline

Tooling infrastructure for modern web component development.
https://outline.phase2tech.com
MIT License
128 stars 27 forks source link

feat(outline-core-link): Updated tooling and build for component. #436

Closed himerus closed 8 months ago

himerus commented 8 months ago

Summary by CodeRabbit

changeset-bot[bot] commented 8 months ago

🦋 Changeset detected

Latest commit: e433cedddd86ee5609e41503c7a1a2219ecbb1ce

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package | Name | Type | | ------------------------- | ----- | | @phase2/outline-core-link | Patch |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai[bot] commented 8 months ago

Walkthrough

The recent update introduces a patch for the @phase2/outline-core-link component, enhancing its build tooling. It includes a new basic HTML page showcasing the outline-core-link custom element, which now extends LitElement for improved functionality and style management. Additionally, the update configures the build settings specifically for this component within a Vite project, alongside a broader Vite configuration tailored for building a library that efficiently handles external dependencies and global mappings for the 'lit' library.

Changes

File Path Change Summary
.changeset/kind-singers-tease.md Introduces a patch for build tooling update for @phase2/outline-core-link.
packages/components/outline-core-link/... Adds a basic HTML page (index.html) and refactors outline-core-link.ts to extend LitElement.
.../outline-core-link/vite.config.js Configures build settings for the component in a Vite project.
vite.config.js Sets up Vite configuration for building a library, specifying ES module output and handling 'lit'.

Tips ### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
netlify[bot] commented 8 months ago

Deploy Preview for outlinejs failed.

Name Link
Latest commit e433cedddd86ee5609e41503c7a1a2219ecbb1ce
Latest deploy log https://app.netlify.com/sites/outlinejs/deploys/65dcbac769aa1a0008fd3958
socket-security[bot] commented 8 months ago

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/@phase2/outline-adopted-stylesheets-controller@1.0.2 Transitive: environment +18 24.6 MB himerus
npm/@phase2/outline-config@0.0.14 None 0 12.5 kB himerus
npm/js-yaml@3.14.1 eval Transitive: environment, filesystem +1 463 kB vitaly
npm/json5@2.2.3 None 0 235 kB jordanbtucker
npm/koa-send@5.0.1 filesystem, network Transitive: environment, eval +6 125 kB niftylettuce
npm/lefthook@1.6.1 environment, shell 0 9.84 kB mrexox
npm/lint-staged@10.5.4 environment, filesystem Transitive: shell, unsafe +35 1.52 MB okonet
npm/lit-analyzer@1.2.1 filesystem +1 1.05 MB runebm
npm/lit-html@2.8.0 None 0 1.81 MB lit-robot
npm/lit@3.1.2 Transitive: environment +6 4.6 MB lit-robot
npm/lodash@4.17.21 None 0 1.41 MB bnjmnt4n
npm/magic-string@0.30.7 None +1 493 kB antfu
npm/make-dir@3.1.0 filesystem +1 78.4 kB sindresorhus
npm/micromatch@4.0.5 None +4 234 kB jonschlinkert
npm/mime-db@1.52.0 None 0 206 kB dougwilson
npm/mime-types@2.1.35 None +1 224 kB dougwilson
npm/minimatch@3.1.2 None +1 46 kB isaacs
npm/minimist-options@4.1.0 None 0 8.53 kB vdemedes
npm/minimist@1.2.8 None 0 54.5 kB ljharb
npm/mkdirp@1.0.4 environment, filesystem 0 19.1 kB isaacs
npm/normalize-path@3.0.0 None 0 9.22 kB jonschlinkert
npm/npm-run-all@4.1.5 environment Transitive: filesystem, shell +8 221 kB mysticatea
npm/npm-run-path@4.0.1 environment +1 12.7 kB sindresorhus
npm/object.assign@4.1.5 Transitive: eval +14 339 kB ljharb
npm/object.fromentries@2.0.7 Transitive: eval +50 3.12 MB ljharb
npm/object.values@1.1.7 Transitive: eval +50 3.13 MB ljharb
npm/on-finished@2.4.1 unsafe 0 13.7 kB dougwilson
npm/onetime@5.1.2 None 0 6.17 kB sindresorhus
npm/open@8.4.2 environment, filesystem, shell 0 46.3 kB sindresorhus
npm/p-limit@2.3.0 None 0 7.39 kB sindresorhus
npm/parse-json@5.2.0 None 0 5.41 kB sindresorhus
npm/parseurl@1.3.3 None 0 10.3 kB dougwilson
npm/path-key@3.1.1 None 0 4.55 kB sindresorhus
npm/picomatch@2.3.1 None 0 90 kB mrmlnc
npm/pirates@4.0.6 unsafe 0 13.5 kB danez
npm/postcss-discard-comments@5.1.0 Transitive: environment, filesystem +1 199 kB ludovicofischer
npm/postcss-loader@7.3.4 eval, unsafe Transitive: environment, filesystem +9 983 kB evilebottnawi
npm/postcss-nested-import@1.3.0 filesystem Transitive: environment +7 426 kB royston
npm/postcss-preset-env@7.8.3 filesystem Transitive: environment, shell +6 2.36 MB alaguna
npm/postcss@8.4.8 environment, filesystem 0 186 kB ai
npm/prettier-plugin-tailwindcss@0.1.13 environment, eval, filesystem, unsafe +1 11.9 MB bradlc
npm/prettier@2.8.8 environment, filesystem, unsafe 0 11.2 MB prettier-bot
npm/progress@2.0.3 None 0 15.5 kB turbopope
npm/qs@6.11.2 Transitive: eval +14 583 kB ljharb
npm/react-dom@18.2.0 environment +1 4.82 MB gnoff
npm/react-syntax-highlighter@15.5.0 Transitive: environment +3 3.11 MB simmerer
npm/react@18.2.0 environment 0 316 kB gnoff
npm/recast@0.23.4 filesystem Transitive: environment, eval +25 1.73 MB eventualbuddha
npm/regexp.prototype.flags@1.5.2 Transitive: eval +14 306 kB ljharb
npm/requireindex@1.2.0 filesystem 0 6.62 kB stephenhandley
npm/resolve-from@5.0.0 filesystem, unsafe 0 5.82 kB sindresorhus
npm/resolve-global@1.0.0 None 0 4.34 kB sindresorhus
npm/resolve@1.22.8 environment, filesystem +5 232 kB ljharb
npm/rimraf@3.0.2 filesystem +3 518 kB isaacs
npm/rollup-plugin-dts@6.1.0 environment, unsafe Transitive: filesystem +30 68.8 MB swatinem
npm/rollup@3.29.4 None 0 0 B lukastaegert
npm/rsync@0.6.1 environment, shell 0 79.5 kB mattijs
npm/safe-buffer@5.1.2 None 0 31.7 kB feross
npm/semver@6.3.1 None 0 68.3 kB lukekarrys
npm/signal-exit@3.0.7 None 0 9.96 kB isaacs
npm/split2@3.2.2 None 0 17.2 kB matteo.collina
npm/storybook@7.6.16 None 0 1.25 kB ndelangen, shilman, usulpro
npm/string-width@4.2.3 None +1 9.19 kB sindresorhus
npm/strip-ansi@6.0.1 None 0 4.03 kB sindresorhus
npm/strip-json-comments@3.1.1 None 0 6.96 kB sindresorhus
npm/svgo@2.8.0 filesystem 0 975 kB trysound
npm/tailwindcss@3.0.0 environment, filesystem Transitive: unsafe +30 5.01 MB malfaitrobin
npm/ts-dedent@2.2.0 None 0 26.6 kB tamino-martinius
npm/ts-lit-plugin@1.2.1 filesystem +2 1.14 MB runebm
npm/tsc@2.0.4 None 0 2.26 kB orta
npm/tslib@2.6.2 None 0 84 kB typescript-bot
npm/turbo@1.12.4 None 0 30.6 kB turbobot
npm/type-is@1.6.18 None +2 242 kB dougwilson
npm/unpipe@1.0.0 None 0 4.31 kB dougwilson
npm/util-deprecate@1.0.2 None 0 5.48 kB tootallnate
npm/util@0.12.5 environment Transitive: eval +16 363 kB goto-bus-stop
npm/vary@1.1.2 None 0 8.75 kB dougwilson
npm/vite@4.5.2 environment, eval, filesystem, network, shell, unsafe +25 215 MB vitebot
npm/vite@5.1.4 Transitive: environment, filesystem, network, shell +44 263 MB antfu, patak, soda, ...2 more
npm/which-typed-array@1.1.14 Transitive: eval +14 306 kB ljharb
npm/yargs@17.7.2 environment, filesystem +3 426 kB oss-bot

🚮 Removed packages: npm/@babel/helper-create-class-features-plugin@7.23.10, npm/@babel/helper-create-regexp-features-plugin@7.22.15, npm/@babel/helper-member-expression-to-functions@7.23.0, npm/@babel/plugin-transform-class-properties@7.23.3, npm/@babel/plugin-transform-modules-commonjs@7.23.3, npm/@babel/plugin-transform-nullish-coalescing-operator@7.23.4, npm/@babel/plugin-transform-optional-chaining@7.23.4, npm/@babel/plugin-transform-private-methods@7.23.3, npm/@csstools/postcss-progressive-custom-properties@1.3.0, npm/@csstools/selector-specificity@2.2.0, npm/@nodelib/fs.stat@2.0.5, npm/@types/unist@2.0.10, npm/@yarnpkg/libzip@2.3.0, npm/bl@4.1.0, npm/camel-case@4.1.2, npm/capital-case@1.0.4, npm/change-case@4.1.2, npm/commander@6.2.1, npm/core-js-compat@3.36.0, npm/css-tree@1.1.3, npm/domelementtype@2.3.0, npm/domhandler@4.3.1, npm/duplexify@3.7.1, npm/end-of-stream@1.4.4, npm/esprima@4.0.1, npm/extend-shallow@3.0.2, npm/fast-glob@3.3.2, npm/get-caller-file@2.0.5, npm/get-value@2.0.6, npm/has-bigints@1.0.2, npm/highlight.js@10.7.3, npm/inherits@2.0.4, npm/is-descriptor@1.0.3, npm/is-docker@2.2.1, npm/is-extendable@0.1.1, npm/is-extglob@2.1.1, npm/is-generator-function@1.0.10, npm/is-plain-object@2.0.4, npm/is-windows@1.0.2, npm/isobject@3.0.1

View full report↗︎

socket-security[bot] commented 8 months ago

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert Package NoteSource
Install scripts npm/lefthook@1.6.1
  • Install script: postinstall
  • Source: node postinstall.js

View full report↗︎

Next steps

What is an install script?

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

Packages should not be running non-essential scripts during install and there are often solutions to problems people solve with install scripts that can be run at publish time instead.

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/foo@1.0.0 or ignore all packages with @SocketSecurity ignore-all

  • @SocketSecurity ignore npm/lefthook@1.6.1