Skip to content

Commit

Permalink
chore: Adjust client generated comments to follow eslint rules (#4832)
Browse files Browse the repository at this point in the history
* fix

* regenrate client
  • Loading branch information
deekshas8 authored Jul 15, 2024
1 parent 86f4158 commit a31dadf
Show file tree
Hide file tree
Showing 141 changed files with 153 additions and 155 deletions.
2 changes: 0 additions & 2 deletions packages/eslint-config/flat-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,12 @@ const jsdoc = require('eslint-plugin-jsdoc');
const regex = require('eslint-plugin-regex');
const unusedImports = require('eslint-plugin-unused-imports');
const importeslint = require('eslint-plugin-import');
const prettierRecommended = require('eslint-plugin-prettier/recommended');
const tseslint = require('typescript-eslint');
const eslint = require('@eslint/js');

const flatConfig = [
eslint.configs.recommended,
...tseslint.configs.recommended,
prettierRecommended,
{
linterOptions: {
reportUnusedDisableDirectives: 'warn'
Expand Down
4 changes: 2 additions & 2 deletions packages/generator/src/batch/function.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export function batchFunction(
{
name: 'requests',
type: 'MethodRequestBuilderBase<ODataRequestConfig>[]',
description: 'The requests of the batch'
description: 'The requests of the batch.'
}
],
returns: {
Expand Down Expand Up @@ -82,7 +82,7 @@ export function changesetFunction(
{
name: 'requests',
type: `Write${service.className}RequestBuilder[]`,
description: 'The requests of the change set'
description: 'The requests of the change set.'
}
],
returns: {
Expand Down
2 changes: 1 addition & 1 deletion packages/generator/src/entity/class.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ function keys(entity: VdmEntity): PropertyDeclarationStructure {
.map(key => `'${key.originalName}'`)
.join(',')}]`,
docs: [
addLeadingNewline(`All key fields of the ${entity.className} entity`)
addLeadingNewline(`All key fields of the ${entity.className} entity.`)
]
};
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export declare class Airlines<T extends DeSerializers = DefaultDeSerializers>
*/
static _defaultBasePath: string;
/**
* All key fields of the Airlines entity
* All key fields of the Airlines entity.
*/
static _keys: string[];
/**
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export class Airlines<T extends DeSerializers = DefaultDeSerializers>
static override _defaultBasePath =
'V4/(S(duh2c3dgb1c5lzc0bqwgyekc))/TripPinServiceRW/';
/**
* All key fields of the Airlines entity
* All key fields of the Airlines entity.
*/
static _keys = ['AirlineCode'];
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export declare class Airports<T extends DeSerializers = DefaultDeSerializers>
*/
static _defaultBasePath: string;
/**
* All key fields of the Airports entity
* All key fields of the Airports entity.
*/
static _keys: string[];
/**
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export class Airports<T extends DeSerializers = DefaultDeSerializers>
static override _defaultBasePath =
'V4/(S(duh2c3dgb1c5lzc0bqwgyekc))/TripPinServiceRW/';
/**
* All key fields of the Airports entity
* All key fields of the Airports entity.
*/
static _keys = ['IcaoCode'];
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import {
} from './index';
/**
* Batch builder for operations supported on the Microsoft O Data Service Sample Trippin In Memory Models Service.
* @param requests The requests of the batch
* @param requests The requests of the batch.
* @returns A request builder for batch.
*/
export declare function batch<DeSerializersT extends DeSerializers>(
Expand All @@ -41,7 +41,7 @@ export declare function batch<DeSerializersT extends DeSerializers>(
): ODataBatchRequestBuilder<DeSerializersT>;
/**
* Change set constructor consists of write operations supported on the Microsoft O Data Service Sample Trippin In Memory Models Service.
* @param requests The requests of the change set
* @param requests The requests of the change set.
* @returns A change set for batch.
*/
export declare function changeset<DeSerializersT extends DeSerializers>(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import {

/**
* Batch builder for operations supported on the Microsoft O Data Service Sample Trippin In Memory Models Service.
* @param requests The requests of the batch
* @param requests The requests of the batch.
* @returns A request builder for batch.
*/
export function batch<DeSerializersT extends DeSerializers>(
Expand Down Expand Up @@ -63,7 +63,7 @@ export function batch<DeSerializersT extends DeSerializers>(

/**
* Change set constructor consists of write operations supported on the Microsoft O Data Service Sample Trippin In Memory Models Service.
* @param requests The requests of the change set
* @param requests The requests of the change set.
* @returns A change set for batch.
*/
export function changeset<DeSerializersT extends DeSerializers>(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export declare class People<T extends DeSerializers = DefaultDeSerializers>
*/
static _defaultBasePath: string;
/**
* All key fields of the People entity
* All key fields of the People entity.
*/
static _keys: string[];
/**
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export class People<T extends DeSerializers = DefaultDeSerializers>
static override _defaultBasePath =
'V4/(S(duh2c3dgb1c5lzc0bqwgyekc))/TripPinServiceRW/';
/**
* All key fields of the People entity
* All key fields of the People entity.
*/
static _keys = ['UserName'];
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export declare class Photos<T extends DeSerializers = DefaultDeSerializers>
*/
static _defaultBasePath: string;
/**
* All key fields of the Photos entity
* All key fields of the Photos entity.
*/
static _keys: string[];
/**
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export class Photos<T extends DeSerializers = DefaultDeSerializers>
static override _defaultBasePath =
'V4/(S(duh2c3dgb1c5lzc0bqwgyekc))/TripPinServiceRW/';
/**
* All key fields of the Photos entity
* All key fields of the Photos entity.
*/
static _keys = ['Id'];
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ import {
} from './index';
/**
* Batch builder for operations supported on the Test Service.
* @param requests The requests of the batch
* @param requests The requests of the batch.
* @returns A request builder for batch.
*/
export declare function batch<DeSerializersT extends DeSerializers>(
Expand All @@ -48,7 +48,7 @@ export declare function batch<DeSerializersT extends DeSerializers>(
): ODataBatchRequestBuilder<DeSerializersT>;
/**
* Change set constructor consists of write operations supported on the Test Service.
* @param requests The requests of the change set
* @param requests The requests of the change set.
* @returns A change set for batch.
*/
export declare function changeset<DeSerializersT extends DeSerializers>(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import {

/**
* Batch builder for operations supported on the Test Service.
* @param requests The requests of the batch
* @param requests The requests of the batch.
* @returns A request builder for batch.
*/
export function batch<DeSerializersT extends DeSerializers>(
Expand Down Expand Up @@ -70,7 +70,7 @@ export function batch<DeSerializersT extends DeSerializers>(

/**
* Change set constructor consists of write operations supported on the Test Service.
* @param requests The requests of the change set
* @param requests The requests of the change set.
* @returns A change set for batch.
*/
export function changeset<DeSerializersT extends DeSerializers>(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export declare class TestEntity<T extends DeSerializers = DefaultDeSerializers>
*/
static _defaultBasePath: string;
/**
* All key fields of the TestEntity entity
* All key fields of the TestEntity entity.
*/
static _keys: string[];
/**
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export class TestEntity<T extends DeSerializers = DefaultDeSerializers>
*/
static override _defaultBasePath = '/odata/test-service';
/**
* All key fields of the TestEntity entity
* All key fields of the TestEntity entity.
*/
static _keys = ['KeyTestEntity'];
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export declare class TestEntity50Prop<
*/
static _defaultBasePath: string;
/**
* All key fields of the TestEntity50Prop entity
* All key fields of the TestEntity50Prop entity.
*/
static _keys: string[];
/**
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export class TestEntity50Prop<T extends DeSerializers = DefaultDeSerializers>
*/
static override _defaultBasePath = '/odata/test-service';
/**
* All key fields of the TestEntity50Prop entity
* All key fields of the TestEntity50Prop entity.
*/
static _keys = ['KeyTestEntity50Prop'];
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export declare class TestEntityLink<
*/
static _defaultBasePath: string;
/**
* All key fields of the TestEntityLink entity
* All key fields of the TestEntityLink entity.
*/
static _keys: string[];
/**
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export class TestEntityLink<T extends DeSerializers = DefaultDeSerializers>
*/
static override _defaultBasePath = '/odata/test-service';
/**
* All key fields of the TestEntityLink entity
* All key fields of the TestEntityLink entity.
*/
static _keys = ['KeyTestEntityLink', 'KeyToTestEntity'];
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export declare class TestEntityWithMultipleKeys<
*/
static _defaultBasePath: string;
/**
* All key fields of the TestEntityWithMultipleKeys entity
* All key fields of the TestEntityWithMultipleKeys entity.
*/
static _keys: string[];
/**
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export class TestEntityWithMultipleKeys<
*/
static override _defaultBasePath = '/odata/test-service';
/**
* All key fields of the TestEntityWithMultipleKeys entity
* All key fields of the TestEntityWithMultipleKeys entity.
*/
static _keys = [
'KeyTestEntityWithMultipleKeys',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import {
import { MultiSchemaTestEntity } from './index';
/**
* Batch builder for operations supported on the Multiple Schemas Service.
* @param requests The requests of the batch
* @param requests The requests of the batch.
* @returns A request builder for batch.
*/
export declare function batch<DeSerializersT extends DeSerializers>(
Expand All @@ -33,7 +33,7 @@ export declare function batch<DeSerializersT extends DeSerializers>(
): ODataBatchRequestBuilder<DeSerializersT>;
/**
* Change set constructor consists of write operations supported on the Multiple Schemas Service.
* @param requests The requests of the change set
* @param requests The requests of the change set.
* @returns A change set for batch.
*/
export declare function changeset<DeSerializersT extends DeSerializers>(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import { MultiSchemaTestEntity } from './index';

/**
* Batch builder for operations supported on the Multiple Schemas Service.
* @param requests The requests of the batch
* @param requests The requests of the batch.
* @returns A request builder for batch.
*/
export function batch<DeSerializersT extends DeSerializers>(
Expand Down Expand Up @@ -55,7 +55,7 @@ export function batch<DeSerializersT extends DeSerializers>(

/**
* Change set constructor consists of write operations supported on the Multiple Schemas Service.
* @param requests The requests of the change set
* @param requests The requests of the change set.
* @returns A change set for batch.
*/
export function changeset<DeSerializersT extends DeSerializers>(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export declare class MultiSchemaTestEntity<
*/
static _defaultBasePath: string;
/**
* All key fields of the MultiSchemaTestEntity entity
* All key fields of the MultiSchemaTestEntity entity.
*/
static _keys: string[];
/**
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit a31dadf

Please sign in to comment.