Skip to content

Commit 0980fe2

Browse files
mocsharpmocsharp
authored
Update .editorconfig to enforce coding styles, naming rules (#62)
* gh-61 Update editorconfig to enforce coding styles, naming rules * gh-61 address errors, warnings and most messages reported by .net analyzers * gh-60 use SPDX license format
1 parent d4c6b34 commit 0980fe2

File tree

301 files changed

+2760
-5801
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

301 files changed

+2760
-5801
lines changed

‎.editorconfig

Lines changed: 228 additions & 166 deletions
Large diffs are not rendered by default.

‎.github/.gitversion.yml

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
1-
# Copyright 2022 MONAI Consortium
2-
# Licensed under the Apache License, Version 2.0 (the "License");
3-
# you may not use this file except in compliance with the License.
4-
# You may obtain a copy of the License at
5-
# http://www.apache.org/licenses/LICENSE-2.0
6-
# Unless required by applicable law or agreed to in writing, software
7-
# distributed under the License is distributed on an "AS IS" BASIS,
8-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
9-
# See the License for the specific language governing permissions and
10-
# limitations under the License.
1+
# SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
2+
# SPDX-License-Identifier: Apache License 2.0
113

124
assembly-versioning-scheme: MajorMinorPatchTag
135
mode: ContinuousDelivery

‎.github/pull_request_template.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
<!--
2+
SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
3+
SPDX-License-Identifier: Apache License 2.0
4+
-->
5+
16
Fixes # .
27

38
### Description

‎.github/workflows/ci.yml

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
1-
# Copyright 2021-2022 MONAI Consortium
2-
# Licensed under the Apache License, Version 2.0 (the "License");
3-
# you may not use this file except in compliance with the License.
4-
# You may obtain a copy of the License at
5-
# http://www.apache.org/licenses/LICENSE-2.0
6-
# Unless required by applicable law or agreed to in writing, software
7-
# distributed under the License is distributed on an "AS IS" BASIS,
8-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
9-
# See the License for the specific language governing permissions and
10-
# limitations under the License.
1+
# SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
2+
# SPDX-License-Identifier: Apache License 2.0
3+
114

125
name: ci
136

‎CODE_OF_CONDUCT.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
<!--
2+
SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
3+
SPDX-License-Identifier: Apache License 2.0
4+
-->
5+
16
# Contributor Covenant Code of Conduct
27

38
## Our Pledge

‎CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<!--
2+
SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
3+
SPDX-License-Identifier: Apache License 2.0
4+
-->
15
- [Introduction](#introduction)
26
- [Communicate with us](#communicate-with-us)
37
- [The contribution process](#the-contribution-process)

‎Dockerfile

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
1-
# Copyright 2021 MONAI Consortium
2-
# Licensed under the Apache License, Version 2.0 (the "License");
3-
# you may not use this file except in compliance with the License.
4-
# You may obtain a copy of the License at
5-
# http://www.apache.org/licenses/LICENSE-2.0
6-
# Unless required by applicable law or agreed to in writing, software
7-
# distributed under the License is distributed on an "AS IS" BASIS,
8-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
9-
# See the License for the specific language governing permissions and
10-
# limitations under the License.
1+
# SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
2+
# SPDX-License-Identifier: Apache License 2.0
113

124
FROM mcr.microsoft.com/dotnet/sdk:6.0-focal as build
135

‎GitReleaseManager.yaml

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
1-
# Copyright 2022 MONAI Consortium
2-
# Licensed under the Apache License, Version 2.0 (the "License");
3-
# you may not use this file except in compliance with the License.
4-
# You may obtain a copy of the License at
5-
# http://www.apache.org/licenses/LICENSE-2.0
6-
# Unless required by applicable law or agreed to in writing, software
7-
# distributed under the License is distributed on an "AS IS" BASIS,
8-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
9-
# See the License for the specific language governing permissions and
10-
# limitations under the License.
1+
# SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
2+
# SPDX-License-Identifier: Apache License 2.0
113

124
issue-labels-include:
135
- breaking
@@ -54,4 +46,4 @@ close:
5446
:tada: This issue has been resolved in version {milestone} :tada:
5547
5648
The release is available on:
57-
- [GitHub Release](https://github.com/{owner}/{repository}/releases/tag/{milestone})
49+
- [GitHub Release](https://github.com/{owner}/{repository}/releases/tag/{milestone})

‎README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
<!--
2+
// SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
3+
// SPDX-License-Identifier: Apache License 2.0
4+
-->
5+
16
<p align="center">
27
<img src="https://raw.githubusercontent.com/Project-MONAI/MONAI/dev/docs/images/MONAI-logo-color.png" width="50%" alt='project-monai'>
38
</p>

‎codecov.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
2+
# SPDX-License-Identifier: Apache License 2.0
3+
14
codecov:
25
require_ci_to_pass: yes
36

‎docs/api/rest/config.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
<!--
2+
SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
3+
SPDX-License-Identifier: Apache License 2.0
4+
-->
5+
16
# Configuration APIs
27

38
The _configuration_ endpoint provides the following APIs to configured the Informatics Gateway.

‎docs/api/rest/health.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
<!--
2+
SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
3+
SPDX-License-Identifier: Apache License 2.0
4+
-->
5+
16
# Health APIs
27

38
The _health_ endpoint provides the following APIs to get statues of the internals of Informatics Gateway.
@@ -77,4 +82,4 @@ curl --location --request GET 'http://localhost:5000/health/live'
7782

7883
```json
7984
"Healthy"
80-
```
85+
```

‎docs/api/rest/inference.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
<!--
2+
SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
3+
SPDX-License-Identifier: Apache License 2.0
4+
-->
5+
16
# Inference Request APIs
27

38
The inference endpoint provides a RESTful interface for triggering a new inference request that is compatible with the ACR DSI API.

‎docs/api/rest/toc.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
- name: Configuration
1+
# SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
2+
# SPDX-License-Identifier: Apache License 2.0
3+
4+
- name: Configuration
25
href: config.md
36
- name: Health
47
href: health.md
58
- name: Inference Request
6-
href: inference.md
9+
href: inference.md

‎docs/api/toc.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
- name: REST API
1+
# SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
2+
# SPDX-License-Identifier: Apache License 2.0
3+
4+
- name: REST API
25
href: rest/toc.yml
36
- name: .NET
4-
href: ../obj/api/dotnet/toc.yml
7+
href: ../obj/api/dotnet/toc.yml

‎docs/changelog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
<!--
2+
SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
3+
SPDX-License-Identifier: Apache License 2.0
4+
-->
5+
16
# Changelog
27

38
## 0.1.1

‎docs/compliance/dicom.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
<!--
2+
SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
3+
SPDX-License-Identifier: Apache License 2.0
4+
-->
5+
16
# DICOM Interface
27

38
The following reference describes the connectivity capabilities of MONAI Deploy SDK out of the box.

‎docs/compliance/open-source-licenses.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
<!--
2+
SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
3+
SPDX-License-Identifier: Apache License 2.0
4+
-->
5+
16
# Open Source Licenses
27

38
---
@@ -66,13 +71,13 @@ A "contributor" is any person that distributes its contribution under this licen
6671
2. Grant of Rights
6772
(A) Copyright Grant- Subject to the terms of this license, including the license conditions
6873
and limitations in section 3, each contributor grants you a non-exclusive, worldwide,
69-
royalty-free copyright license to reproduce its contribution, prepare derivative works
70-
of its contribution, and distribute its contribution or any derivative works that you create.
74+
royalty-free copyright license to reproduce its contribution, prepare derivative works
75+
of its contribution, and distribute its contribution or any derivative works that you create.
7176
(B) Patent Grant- Subject to the terms of this license, including the license conditions and
7277
limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free
73-
license under its licensed patents to make, have made, use, sell, offer for sale, import,
74-
and/or otherwise dispose of its contribution in the software or derivative works of the
75-
contribution in the software.
78+
license under its licensed patents to make, have made, use, sell, offer for sale, import,
79+
and/or otherwise dispose of its contribution in the software or derivative works of the
80+
contribution in the software.
7681
7782
3. Conditions and Limitations
7883
(A) No Trademark License- This license does not grant you rights to use any contributors' name,
@@ -83,13 +88,13 @@ A "contributor" is any person that distributes its contribution under this licen
8388
and attribution notices that are present in the software.
8489
(D) If you distribute any portion of the software in source code form, you may do so only under this
8590
license by including a complete copy of this license with your distribution. If you distribute
86-
any portion of the software in compiled or object code form, you may only do so under a license
87-
that complies with this license.
91+
any portion of the software in compiled or object code form, you may only do so under a license
92+
that complies with this license.
8893
(E) The software is licensed "as-is." You bear the risk of using it. The contributors give no express
8994
warranties, guarantees or conditions. You may have additional consumer rights under your local
90-
laws which this license cannot change. To the extent permitted under your local laws, the
91-
contributors exclude the implied warranties of merchantability, fitness for a particular purpose
92-
and non-infringement.
95+
laws which this license cannot change. To the extent permitted under your local laws, the
96+
contributors exclude the implied warranties of merchantability, fitness for a particular purpose
97+
and non-infringement.
9398
9499
95100

‎docs/compliance/toc.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
1-
# [DICOM](dicom.md)
2-
# [Open Source Licenses](open-source-licenses.md)
1+
<!--
2+
SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
3+
SPDX-License-Identifier: Apache License 2.0
4+
-->
5+
6+
# [DICOM](dicom.md)
7+
# [Open Source Licenses](open-source-licenses.md)

‎docs/filterConfig.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
2+
# SPDX-License-Identifier: Apache License 2.0
3+
14
apiRules:
25
- exclude:
36
hasAttribute:
@@ -8,4 +11,4 @@ apiRules:
811
- exclude:
912
# inherited Object methods
1013
uidRegex: ^System\.Object\..*$
11-
type: Method
14+
type: Method

‎docs/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
<!--
2+
SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
3+
SPDX-License-Identifier: Apache License 2.0
4+
-->
5+
16
# MONAI Deploy Informatics Gateway <small>v0.0.0</small>
27

38
![NVIDIA](./images/MONAI-logo_color.svg)

‎docs/setup/schema.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
<!--
2+
SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
3+
SPDX-License-Identifier: Apache License 2.0
4+
-->
5+
6+
17
# Configuration
28

39
## Informatics Gateway Configuration File
@@ -180,4 +186,4 @@ The following log level may be used:
180186
Additional information may be found on `docs.microsoft.com`:
181187

182188
- [LogLevel Enum](https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.logging.loglevel)
183-
- [Logging in .NET](https://docs.microsoft.com/en-us/dotnet/core/extensions/logging)
189+
- [Logging in .NET](https://docs.microsoft.com/en-us/dotnet/core/extensions/logging)

‎docs/setup/setup.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
<!--
2+
SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
3+
SPDX-License-Identifier: Apache License 2.0
4+
-->
5+
16
# Setup
27

38
This section outlines the steps to download and install Informatics Gateway using the CLI and Docker image.

‎docs/setup/toc.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
1-
# [Setup](setup.md)
2-
# [Configuration](schema.md)
1+
<!--
2+
SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
3+
SPDX-License-Identifier: Apache License 2.0
4+
-->
5+
6+
# [Setup](setup.md)
7+
# [Configuration](schema.md)

‎docs/toc.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
2+
# SPDX-License-Identifier: Apache License 2.0
3+
14
- name: MONAI Deploy Informatics Gateway
25
href: index.md
36
- name: Get Started
@@ -7,4 +10,4 @@
710
- name: Compliance
811
href: compliance/
912
- name: Changelog
10-
href: changelog.md
13+
href: changelog.md

‎guidelines/mig-drd.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
<!--
2+
SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
3+
SPDX-License-Identifier: Apache License 2.0
4+
-->
5+
6+
17
# MONAI Deploy Informatics Gateway Requirements
28

39
## Overview

‎guidelines/srs.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
<!--
2+
SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
3+
SPDX-License-Identifier: Apache License 2.0
4+
-->
5+
16
# MONAI Deploy Informatics Gateway Software Architecture & Design
27

38
## Overview

‎src/Api/BaseApplicationEntity.cs

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,6 @@
1-
// Copyright 2021 MONAI Consortium
2-
// Licensed under the Apache License, Version 2.0 (the "License");
3-
// you may not use this file except in compliance with the License.
4-
// You may obtain a copy of the License at
5-
// http://www.apache.org/licenses/LICENSE-2.0
6-
// Unless required by applicable law or agreed to in writing, software
7-
// distributed under the License is distributed on an "AS IS" BASIS,
8-
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
9-
// See the License for the specific language governing permissions and
10-
// limitations under the License.
11-
12-
/*
13-
* Apache License, Version 2.0
14-
* Copyright 2019-2020 NVIDIA Corporation
15-
*
16-
* Licensed under the Apache License, Version 2.0 (the "License");
17-
* you may not use this file except in compliance with the License.
18-
* You may obtain a copy of the License at
19-
*
20-
* http://www.apache.org/licenses/LICENSE-2.0
21-
*
22-
* Unless required by applicable law or agreed to in writing, software
23-
* distributed under the License is distributed on an "AS IS" BASIS,
24-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25-
* See the License for the specific language governing permissions and
26-
* limitations under the License.
27-
*/
1+
// SPDX-FileCopyrightText: © 2021-2022 MONAI Consortium
2+
// SPDX-FileCopyrightText: © 2019-2020 NVIDIA Corporation
3+
// SPDX-License-Identifier: Apache License 2.0
284

295
namespace Monai.Deploy.InformaticsGateway.Api
306
{

0 commit comments

Comments
 (0)