Merge 29f2dbf into 412b05e

justinfagnani · web-flow · commit aabae5f031c4 · 2022-11-05T10:23:44.000-07:00
diff --git a/.changeset/unlucky-parents-melt.md b/.changeset/unlucky-parents-melt.md
@@ -0,0 +1,5 @@
+---
+'@lit-labs/context': patch
+---
+
+Rename @contextProvided and @contextProvider to @consume and @provide
diff --git a/packages/labs/context/README.md b/packages/labs/context/README.md
@@ -32,18 +32,18 @@ export const loggerContext = createContext<Logger>('logger');
 
 Now we can define a consumer for this context - some component in our app needs the logger.
 
-Here we're using the `@contextProvided` property decorator to make a `ContextConsumer` controller
+Here we're using the `@consume` property decorator to make a `ContextConsumer` controller
 and update its value when the context changes:
 
 #### **`my-element.ts`**:
 
 ```ts
-import {contextRequest} from '@lit-labs/context';
 import {LitElement, property} from 'lit';
+import {consume} from '@lit-labs/context';
 import {Logger, loggerContext} from './logger.js';
 
 export class MyElement extends LitElement {
-  @contextProvided({context: loggerContext, subscribe: true})
+  @consume({context: loggerContext, subscribe: true})
   @property({attribute: false})
   public logger?: Logger;
 
@@ -80,18 +80,18 @@ export class MyElement extends LitElement {
 
 Finally we want to be able to provide this context from somewhere higher in the DOM.
 
-Here we're using a `@contextProvider` property decorator to make a `ContextProvider`
+Here we're using a `@provide` property decorator to make a `ContextProvider`
 controller and update its value when the property value changes.
 
 #### **`my-app.ts`**:
 
 ```ts
 import {LitElement} from 'lit';
-import {contextProvider} from '@lit-labs/context';
-import {loggerContext, Logger} from './my-logger.js';
+import {provide} from '@lit-labs/context';
+import {loggerContext, Logger} from './logger.js';
 
 export class MyApp extends LitElement {
-  @contextProvider({context: loggerContext})
+  @provide({context: loggerContext})
   @property({attribute: false})
   public logger: Logger = {
     log: (msg) => {
@@ -112,7 +112,7 @@ We can also use the `ContextProvider` controller directly:
 ```ts
 import {LitElement} from 'lit';
 import {ContextProvider} from '@lit-labs/context';
-import {loggerContext, Logger} from './my-logger.js';
+import {loggerContext, Logger} from './logger.js';
 
 export class MyApp extends LitElement {
   // create a provider controller and a default logger
diff --git a/packages/labs/context/src/index.ts b/packages/labs/context/src/index.ts
@@ -15,5 +15,18 @@ export {ContextConsumer} from './lib/controllers/context-consumer.js';
 export {ContextProvider} from './lib/controllers/context-provider.js';
 export {ContextRoot} from './lib/context-root.js';
 
-export {contextProvider} from './lib/decorators/context-provider.js';
-export {contextProvided} from './lib/decorators/context-provided.js';
+export {provide} from './lib/decorators/provide.js';
+export {consume} from './lib/decorators/consume.js';
+
+import {provide} from './lib/decorators/provide.js';
+import {consume} from './lib/decorators/consume.js';
+
+/**
+ * @deprecated use `provide` instead
+ */
+export const contextProvider = provide;
+
+/**
+ * @deprecated use `consume` instead
+ */
+export const contextProvided = consume;
diff --git a/packages/labs/context/src/lib/decorators/consume.ts b/packages/labs/context/src/lib/decorators/consume.ts
@@ -27,10 +27,11 @@ import {ContextKey} from '../context-key.js';
  * @example
  *
  * ```ts
+ * import {consume} from '@lit-labs/context';
  * import {loggerContext, Logger} from 'community-protocols/logger';
  *
  * class MyElement {
- *   @contextProvided({context: loggerContext})
+ *   @consume({context: loggerContext})
  *   logger?: Logger;
  *
  *   doThing() {
@@ -40,7 +41,7 @@ import {ContextKey} from '../context-key.js';
  * ```
  * @category Decorator
  */
-export function contextProvided<ValueType>({
+export function consume<ValueType>({
   context: context,
   subscribe,
 }: {
diff --git a/packages/labs/context/src/lib/decorators/provide.ts b/packages/labs/context/src/lib/decorators/provide.ts
@@ -29,10 +29,11 @@ import {ContextProvider} from '../controllers/context-provider.js';
  * @example
  *
  * ```ts
+ * import {consume} from '@lit-labs/context';
  * import {loggerContext} from 'community-protocols/logger';
  *
  * class MyElement {
- *   @contextProvided(loggerContext)
+ *   @provide(loggerContext)
  *   logger;
  *
  *   doThing() {
@@ -42,7 +43,7 @@ import {ContextProvider} from '../controllers/context-provider.js';
  * ```
  * @category Decorator
  */
-export function contextProvider<ValueType>({
+export function provide<ValueType>({
   context: context,
 }: {
   context: ContextKey<unknown, ValueType>;
diff --git a/packages/labs/context/src/test/context-provider_test.ts b/packages/labs/context/src/test/context-provider_test.ts
@@ -7,13 +7,13 @@
 import {LitElement, html, TemplateResult} from 'lit';
 import {property} from 'lit/decorators/property.js';
 
-import {ContextKey, contextProvided, contextProvider} from '@lit-labs/context';
+import {ContextKey, consume, provide} from '@lit-labs/context';
 import {assert} from '@esm-bundle/chai';
 
 const simpleContext = 'simple-context' as ContextKey<'simple-context', number>;
 
 class ContextConsumerElement extends LitElement {
-  @contextProvided({context: simpleContext, subscribe: true})
+  @consume({context: simpleContext, subscribe: true})
   @property({type: Number})
   public value = 0;
 
@@ -24,7 +24,7 @@ class ContextConsumerElement extends LitElement {
 customElements.define('context-consumer', ContextConsumerElement);
 
 class ContextProviderElement extends LitElement {
-  @contextProvider({context: simpleContext})
+  @provide({context: simpleContext})
   @property({type: Number, reflect: true})
   public value = 0;
 
diff --git a/packages/labs/context/src/test/context-request_test.ts b/packages/labs/context/src/test/context-request_test.ts
@@ -11,7 +11,7 @@ import {
   ContextConsumer,
   ContextProvider,
   createContext,
-  contextProvided,
+  consume,
 } from '@lit-labs/context';
 import {assert} from '@esm-bundle/chai';
 
@@ -31,12 +31,12 @@ class SimpleContextProvider extends LitElement {
 
 class SimpleContextConsumer extends LitElement {
   // a one-time property fullfilled by context
-  @contextProvided({context: simpleContext})
+  @consume({context: simpleContext})
   @property({type: Number})
   public onceValue = 0;
 
   // a subscribed property fulfilled by context
-  @contextProvided({context: simpleContext, subscribe: true})
+  @consume({context: simpleContext, subscribe: true})
   @property({type: Number})
   public subscribedValue = 0;
 
diff --git a/packages/labs/context/src/test/late-provider_test.ts b/packages/labs/context/src/test/late-provider_test.ts
@@ -7,22 +7,17 @@
 import {LitElement, html, TemplateResult} from 'lit';
 import {property} from 'lit/decorators/property.js';
 
-import {
-  ContextKey,
-  contextProvided,
-  contextProvider,
-  ContextRoot,
-} from '@lit-labs/context';
+import {ContextKey, consume, provide, ContextRoot} from '@lit-labs/context';
 import {assert} from '@esm-bundle/chai';
 
 const simpleContext = 'simple-context' as ContextKey<'simple-context', number>;
 
 class ContextConsumerElement extends LitElement {
-  @contextProvided({context: simpleContext, subscribe: true})
+  @consume({context: simpleContext, subscribe: true})
   @property({type: Number})
   public value = 0;
 
-  @contextProvided({context: simpleContext})
+  @consume({context: simpleContext})
   @property({type: Number})
   public onceValue = 0;
 
@@ -33,7 +28,7 @@ class ContextConsumerElement extends LitElement {
 customElements.define('context-consumer', ContextConsumerElement);
 
 class LateContextProviderElement extends LitElement {
-  @contextProvider({context: simpleContext})
+  @provide({context: simpleContext})
   @property({type: Number, reflect: true})
   public value = 0;
 
diff --git a/packages/labs/context/src/test/provider-and-consumer_test.ts b/packages/labs/context/src/test/provider-and-consumer_test.ts
@@ -7,17 +7,17 @@
 import {LitElement, html, TemplateResult} from 'lit';
 import {property} from 'lit/decorators/property.js';
 
-import {ContextKey, contextProvided, contextProvider} from '@lit-labs/context';
+import {ContextKey, consume, provide} from '@lit-labs/context';
 import {assert} from '@esm-bundle/chai';
 
 const simpleContext = 'simple-context' as ContextKey<'simple-context', number>;
 
 class ContextConsumerAndProviderElement extends LitElement {
-  @contextProvided({context: simpleContext, subscribe: true})
+  @consume({context: simpleContext, subscribe: true})
   @property({type: Number})
   public provided = 0;
 
-  @contextProvider({context: simpleContext})
+  @provide({context: simpleContext})
   @property({type: Number})
   public value = 0;
 

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@lit-labs/context': patch
 +---
++
 +Rename @contextProvided and @contextProvider to @consume and @provide