Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomaszrewak/privatest
Adding instance-level accessibility mode to C#
https://github.com/tomaszrewak/privatest
accessibility analyzer compilation csharp roslyn roslyn-analyzer roslyn-codefix scala
Last synced: 25 days ago
JSON representation
Adding instance-level accessibility mode to C#
- Host: GitHub
- URL: https://github.com/tomaszrewak/privatest
- Owner: TomaszRewak
- License: mit
- Created: 2021-02-06T19:13:27.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-04-17T21:56:00.000Z (almost 4 years ago)
- Last Synced: 2024-11-09T18:37:47.155Z (3 months ago)
- Topics: accessibility, analyzer, compilation, csharp, roslyn, roslyn-analyzer, roslyn-codefix, scala
- Language: C#
- Homepage:
- Size: 94.7 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Privatest
Privatest is a code analyzer that adds instance-level accessibility mode to C#.
### Setup
To set it up simply install the `Privatest` Nuget package in your project:
```
dotnet add package Privatest
```
### Usage
To assign an instance-level accessibility mode to a member of a class, decorate it with the `[This]` attribute.
```csharp
public class Class
{
[This] private int _field;
public void Method(Class other)
{
_field = 10; // OK
other._field = 10; // ERROR
//^^^^^^^^^^^^ `_field` is inaccessible due to its protection level. It can only be accessed by the instance to which it belongs (through the `this` reference).
}
}
```
You can apply the `[This]` attribute on fields, methods and properties (including property getters and setters).
The `[This]` attribute can only be applied on private members.
```csharp
public class Class
{
[This] public int Property { get; set; }
//^^^^^^^^ [This] attribute can be applied only on private members, but was applied on 'Public' member 'Property'
}
```
The `[This]` attribute can also be used to limit the accessibility of a member to a specific scope only. It can be useful when working with backing fields, which should be accessed only by the associated properties.
```csharp
public class Class
{
[This(nameof(FrontProperty))] private int _backField;
public int FrontProperty
{
get => _backField;
set => _backField = value;
}
public void Method(Class other)
{
_backField = 2;
//^^^^^^^^^^ `_backField` is inaccessible due to its protection level. It can only be accessed in `FrontProperty` (but is used in `Method`).
}
}
```
The scope can be limited to any method or property of a class. It can by specified either by using the `nameof` operator or as a plain string value.
In case of backing fields that have the same name as their front properties (just starting with a lower case letter and/or `_` character), one can also use the `[BackingField]` attribute which will work the same way as a longer `[This(nameof(FrontPropertyName))]`.
```csharp
public class Class
{
[BackingField] private int _name;
public int Name
{
get => _name;
set => _name = value;
}
public int Surname
{
get => _name;
//^^^^^ `_name` is inaccessible due to its protection level. It can only be accessed in `Name` (but is used in `Surname`).
}
}
```
### How does it work?
Privatest is a C# code analyzer that performs accessibility checks during the compilation stage only (using Roslyn hooks). It does not introduce any additional checks in the compiled code and therefore does not impact its performance.
## Contributions
I am open to PRs as well as github issues.