Skip to content

Commit

Permalink
docs: fix typos (#1569)
Browse files Browse the repository at this point in the history
* docs: fix typos

* add changeset

---------

Co-authored-by: Ryan Carniato <ryansolid@gmail.com>
  • Loading branch information
Lioness100 and ryansolid authored Feb 21, 2023
1 parent e245736 commit 676ed33
Show file tree
Hide file tree
Showing 12 changed files with 22 additions and 14 deletions.
8 changes: 8 additions & 0 deletions .changeset/clever-news-cross.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
"babel-preset-solid": patch
"solid-element": patch
"solid-js": patch
"test-integration": patch
---

docs: fix typos
2 changes: 1 addition & 1 deletion packages/babel-preset-solid/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Via package.json
```

### Usage for SSR code
When need to tranform JSX code to be used on the server, pass the following options
When need to transform JSX code to be used on the server, pass the following options

```javascript
{
Expand Down
2 changes: 1 addition & 1 deletion packages/solid-element/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
![](https://img.shields.io/librariesio/release/npm/solid-element)
![](https://img.shields.io/npm/dm/solid-element.svg?style=flat)

This library extends [Solid](https://github.com/solidjs/solid) by adding Custom Web Components and extensions to manage modular behaviors and composition. It uses [Component Register](https://github.com/ryansolid/component-register) to create Web Components and its composed mixin pattern to construct modular re-usable behaviors. This allows your code to available as simple HTML elements for library interopt and to leverage Shadow DOM style isolation. Solid already supports binding to Web Components so this fills the gap allowing full modular applications to be built out of nested Web Components. Component Register makes use of the V1 Standards and on top of being compatible with the common webcomponent.js polyfills, has a solution for Polyfilling Shadow DOM CSS using the ShadyCSS Parser from Polymer in a generic framework agnostic way (unlike the ShadyCSS package).
This library extends [Solid](https://github.com/solidjs/solid) by adding Custom Web Components and extensions to manage modular behaviors and composition. It uses [Component Register](https://github.com/ryansolid/component-register) to create Web Components and its composed mixin pattern to construct modular re-usable behaviors. This allows your code to available as simple HTML elements for library interop and to leverage Shadow DOM style isolation. Solid already supports binding to Web Components so this fills the gap allowing full modular applications to be built out of nested Web Components. Component Register makes use of the V1 Standards and on top of being compatible with the common webcomponent.js polyfills, has a solution for Polyfilling Shadow DOM CSS using the ShadyCSS Parser from Polymer in a generic framework agnostic way (unlike the ShadyCSS package).

## Example

Expand Down
4 changes: 2 additions & 2 deletions packages/solid/bench/results.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Benchmark Results (22/09/2022)

This benchmark is mostly to serve Solid's own R&D. Everything is co-erced to Solid's API shape as that is a necessity here. While most libaries presented are unsuitable for Solid's rendering because of missing features/capabilities it is still useful to help gauge where the implementations fall. In most UI libraries you'd be bringing in overhead from a VDOM or other rendering model where Solid's reactivity takes the brunt of that cost.
This benchmark is mostly to serve Solid's own R&D. Everything is coerced to Solid's API shape as that is a necessity here. While most libraries presented are unsuitable for Solid's rendering because of missing features/capabilities it is still useful to help gauge where the implementations fall. In most UI libraries you'd be bringing in overhead from a VDOM or other rendering model where Solid's reactivity takes the brunt of that cost.

## Released Libraries

Expand Down Expand Up @@ -385,4 +385,4 @@ updateComputations1to4: 21
updateComputations1to1000: 18
update total: 115
total: 212
```
```
2 changes: 1 addition & 1 deletion packages/solid/h/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ h(Button, { title: "My button" }, "Click Me")
h("div", { title: "My button" }, h("span", "1"), h("span", "2"), h("span", "3"))
```

This is the least efficient way to use Solid as it requires a slightly larger runtime that isn't treeshakebable, and cannot leverage anything in the way of analysis, so it requires manual wrapping of expressions and has a few other caveats (see below).
This is the least efficient way to use Solid as it requires a slightly larger runtime that isn't treeshakeable, and cannot leverage anything in the way of analysis, so it requires manual wrapping of expressions and has a few other caveats (see below).

## Example

Expand Down
4 changes: 2 additions & 2 deletions packages/solid/html/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ html`<${Button} title="My button">Click me<//>`
html`<div title=${() => selectedClass()} ...${props} />`
```

Using `html` is slightly less efficient than JSX(but more than HyperScript), requires a larger runtime that isn't treeshakebable, and cannot leverage expression analysis, so it requires manual wrapping of expressions and has a few other caveats (see below).
Using `html` is slightly less efficient than JSX(but more than HyperScript), requires a larger runtime that isn't treeshakeable, and cannot leverage expression analysis, so it requires manual wrapping of expressions and has a few other caveats (see below).

## Example

Expand Down Expand Up @@ -66,7 +66,7 @@ html`<${Button} onClick=${() => console.log("Hi")} />`;

4. All refs are callback form

We can't do the compiled assigment trick so only the callback form is supported.
We can't do the compiled assignment trick so only the callback form is supported.

```js
let myEl;
Expand Down
2 changes: 1 addition & 1 deletion packages/solid/store/test/mutable.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { createRoot, createSignal, createMemo, batch, createEffect } from "../..
import { Accessor, Setter } from "../../types";
import { createMutable, unwrap, $RAW } from "../src";

describe("State Mutablity", () => {
describe("State Mutability", () => {
test("Setting a property", () => {
const user = createMutable({ name: "John" });
expect(user.name).toBe("John");
Expand Down
2 changes: 1 addition & 1 deletion packages/solid/store/test/store.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
} from "../../src";
import { createStore, unwrap, $RAW, NotWrappable } from "../src";

describe("State immutablity", () => {
describe("State immutability", () => {
test("Setting a property", () => {
const [state] = createStore({ name: "John" });
expect(state.name).toBe("John");
Expand Down
2 changes: 1 addition & 1 deletion packages/solid/test/signals.memo.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ describe("createMemo", () => {
});
});

it("evaluates stale computations before dependendees when trackers stay unchanged", () => {
it("evaluates stale computations before dependees when trackers stay unchanged", () => {
createRoot(() => {
let [s1, set] = createSignal(1, { equals: false });
let order = "";
Expand Down
2 changes: 1 addition & 1 deletion packages/solid/test/signals.type-tests.ts
Original file line number Diff line number Diff line change
Expand Up @@ -426,7 +426,7 @@ createMemo((v: number | string): number => 123, "asdf");
createMemo((num: number | undefined): number | undefined => 123);

// Return type should be `Accessor<number | undefined>`
// Not sure how to write a test for this, becacuse `Accessor<number>` is assignable to `Accessor<number | undefined>`.
// Not sure how to write a test for this, because `Accessor<number>` is assignable to `Accessor<number | undefined>`.
let c1 = createMemo((num?: number): number | undefined => undefined);
let n = c1();
// @ts-expect-error n might be undefined
Expand Down
4 changes: 2 additions & 2 deletions packages/solid/web/test/suspense.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ describe("Testing Suspense", () => {

// Exhausts create-resource setTimeout
jest.runAllTimers();
// wait update suspence state
// wait update suspense state
await Promise.resolve();
// wait update computation
jest.runAllTimers();
Expand Down Expand Up @@ -118,7 +118,7 @@ describe("Testing Suspense", () => {

// Exhausts create-resource setTimeout
jest.runAllTimers();
// wait update suspence state
// wait update suspense state
await Promise.resolve();
// wait update computation
jest.runAllTimers();
Expand Down
2 changes: 1 addition & 1 deletion packages/test-integration/tests/downloaded.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ describe("Downloaded tests", () => {
throw new Error("Solid is not built. Run `npm run build`");
}

// clean downloded packages
// clean downloaded packages
if (clean) {
rm("-rf", resolve(join(__dirname, "./fixtures/downloaded")));
}
Expand Down

0 comments on commit 676ed33

Please sign in to comment.